@getlupa/client 0.16.2 → 1.0.2

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

@@ -1,61 +0,0 @@
-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;
-    showTitle?: (field: BadgeGenerateSeed) => boolean;
-    customClass?: (field: BadgeGenerateSeed) => string | undefined;
-};
-export declare type BadgeOptions = {
-    anchor: AnchorPosition;
-    elements: BadgeElement[];
-    generate?: BadgeGenerateOptions;
-    product?: any;
-};
-export declare type SearchResultBadgeElement<T = any> = {
-    type: SearchResultBadgeType;
-    key: string;
-    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<T = any> = SearchResultBadgeElement<T> & {
-    value?: string;
-};
-export declare type TextBadgeElement<T = any> = BaseBadgeElement<T> & {
-    type: "text";
-    prefix?: string;
-    maxItems?: number;
-};
-export declare type ImageBadgeElement<T = any> = BaseBadgeElement<T> & {
-    type: "image";
-    rootImageUrl?: string;
-    maxItems?: number;
-};
-export declare type CustomHtmlBadgeElement<T = any> = BaseBadgeElement<T> & {
-    type: "customHtml";
-    className?: string;
-    html: (doc: T) => string;
-};
-export declare type BadgeElement = BaseBadgeElement | TextBadgeElement;
-export declare enum BadgeType {
-    DISCOUNTPERCENTAGE = "discountPercentage",
-    DISCOUNTAMOUNT = "discountAmount",
-    NEWITEM = "newItem",
-    TEXT = "text",
-    IMAGE = "image",
-    CUSTOM_HTML = "customHtml"
-}

package/dist/iife/types/search-results/FacetAction.d.ts

@@ -1,16 +0,0 @@
-export declare type TermFacetAction = {
-    type: "terms";
-    value: string;
-    key: string;
-};
-export declare type HierarchyFacetAction = {
-    type: "hierarchy";
-    value: string;
-    key: string;
-};
-export declare type RangeFacetAction = {
-    type: "range";
-    value: string[];
-    key: string;
-};
-export declare type FacetAction = TermFacetAction | RangeFacetAction | HierarchyFacetAction;

package/dist/iife/types/search-results/Filters.d.ts

@@ -1,9 +0,0 @@
-export declare type UnfoldedFilter = {
-    key: string;
-    value: string;
-    type: FilterType;
-};
-export declare type LabeledFilter = UnfoldedFilter & {
-    label: string;
-};
-export declare type FilterType = "terms" | "range" | "hierarchy";

package/dist/iife/types/search-results/PaginationOptions.d.ts

@@ -1,20 +0,0 @@
-import { SearchResultsPaginationLabels } from "./SearchResultsPagination";
-export declare type PaginationOptions = {
-    pageSize: PaginationPageSize;
-    pageSelect: PaginationPageSelect;
-    labels: SearchResultsPaginationLabels;
-};
-export declare type PaginationPageSize = {
-    sizes: number[];
-    selectedSize: number;
-};
-export declare type PaginationPageSelect = {
-    count: number;
-    selectedPage: number;
-    display: number;
-    displayMobile: number;
-};
-export declare type PaginationDisplay = {
-    pageSize: boolean;
-    pageSelect: boolean;
-};

package/dist/iife/types/search-results/QueryParams.d.ts

@@ -1,4 +0,0 @@
-import { FilterGroup } from "@getlupa/client-sdk/Types";
-export declare type QueryParams = {
-    filters?: FilterGroup;
-} & Record<string, string>;

package/dist/iife/types/search-results/ResultsLayout.d.ts

@@ -1,5 +0,0 @@
-export declare type ResultsLayout = "Grid" | "List";
-export declare enum ResultsLayoutEnum {
-    GRID = "Grid",
-    LIST = "List"
-}

package/dist/iife/types/search-results/RoutingBehavior.d.ts

@@ -1 +0,0 @@
-export declare type RoutingBehavior = "direct-link" | "event";

package/dist/iife/types/search-results/SearchResultsAdditionalPanelOptions.d.ts

@@ -1,15 +0,0 @@
-import { DocumentElement } from "../DocumentElement";
-export declare type SearchResultsAdditionalPanelOptions = {
-    location: "top" | "bottom";
-    queryKey: string;
-    initialCountLimit: number;
-    totalCountLimit: number;
-    links?: {
-        details: string;
-    };
-    labels: {
-        showMore: string;
-        showLess: string;
-    };
-    elements: DocumentElement[];
-};

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

@@ -1,177 +0,0 @@
-import { SdkOptions } from "../General";
-import { CategoryFilterOptions } from "../product-list/ProductListOptions";
-import { SearchResultsAdditionalPanelOptions } from "./SearchResultsAdditionalPanelOptions";
-import { SearchResultsProductCardOptions } from "./SearchResultsProductCardOptions";
-import { SearchResultsSortOptions } from "./SearchResultsSort";
-export declare type SearchResultsOptions = SearchResultsProductOptions & SearchResultsAdditionalPanels & {
-    containerSelector: string;
-    breadcrumbs: SearchResultsBreadcrumb[];
-    classMap?: Record<string, string>;
-    disallowEmptyQuery?: boolean;
-    callbacks?: SearchResultEventCallbacks;
-    categories?: CategoryFilterOptions;
-    dynamicData?: DynamicData;
-};
-export declare type SearchTitlePosition = "page-top" | "search-results-top";
-export declare type SearchResultsDidYouMeanLabels = {
-    noResultsSuggestion: string;
-    didYouMean: string;
-};
-export declare type SearchResultsSimilarQueriesLabels = {
-    similarQuery: string;
-    similarQueries: string;
-    aiSuggestions?: string;
-};
-export declare type CallbackContext = {
-    queryKey: string;
-    hasResults?: boolean;
-    urlQueryString?: string;
-    productId?: 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 & {
-    sortBy: string;
-    currency: string;
-    priceSeparator?: string;
-    searchResults?: string;
-    itemCount: string;
-    emptyResults: string;
-    mobileFilterButton: string;
-    htmlTitleTemplate: string;
-    outOfStock?: string;
-    noItemsInPage?: string;
-    backToFirstPage?: string;
-};
-export declare type SearchResultsAdditionalPanels = {
-    additionalPanels?: SearchResultsAdditionalPanelOptions[];
-};
-export declare type SearchResultsProductOptions = SearchResultsProductCardOptions & SearchResultsAdditionalPanels & {
-    grid: ProductGrid;
-    options: SdkOptions;
-    queryKey: string;
-    pagination: SearchResultsPagination;
-    sort: SearchResultsSortOptions[];
-    filters?: SearchResultsFilterOptions;
-    searchTitlePosition?: string;
-    toolbar?: {
-        layoutSelector?: boolean;
-        itemSummary?: boolean;
-        clearFilters?: boolean;
-        totalCount?: boolean;
-    };
-};
-export declare type ProductGrid = {
-    columns: {
-        xl: number;
-        l: number;
-        md: number;
-        sm: number;
-        xs: number;
-    };
-};
-export declare type SearchResultsPaginationLabels = {
-    pageSize: string;
-    showMore: string;
-    showLess?: string;
-};
-export declare type ResponsiveSearchResultPageSizes = {
-    xs: number[];
-    sm: number[];
-    md: number[];
-    l: number[];
-    xl: number[];
-};
-export declare type SearchResultPageSizes = number[] | ResponsiveSearchResultPageSizes;
-export declare type SearchResultsPagination = {
-    sizeSelection: {
-        sizes: SearchResultPageSizes;
-        position: SearchResultsPaginationPosition;
-    };
-    pageSelection: {
-        position: SearchResultsPaginationPosition;
-        display: number;
-        displayMobile: number;
-    };
-};
-export declare type SearchResultsPaginationPosition = {
-    top: boolean;
-    bottom: boolean;
-};
-export declare type ResultCurrentFilterOptions = {
-    labels: {
-        title: string;
-        clearAll: string;
-    };
-    visibility?: {
-        mobileSidebar?: boolean;
-        mobileToolbar?: boolean;
-        desktopSidebar?: boolean;
-        desktopToolbar?: boolean;
-    };
-    mobileSidebar?: {
-        showFilterCount?: boolean;
-        activeFiltersExpanded?: boolean;
-    };
-    desktopToolbar?: {
-        activeFiltersExpanded?: boolean;
-    };
-};
-export declare type FacetStyle = "sidebar" | "top-dropdown";
-export declare type FacetFilterQuery = {
-    queryKey: string;
-};
-export declare type ResultFacetOptions = {
-    labels: {
-        title: string;
-        showAll: string;
-        showLess?: string;
-        facetFilter: string;
-        facetClear?: string;
-    };
-    promotedFacets?: string[];
-    filterable?: {
-        minValues: number;
-    };
-    hierarchy?: {
-        maxInitialLevel: number;
-        topLevelValueCountLimit?: number;
-        filterable?: boolean;
-    };
-    stats?: {
-        slider?: boolean;
-        inputs?: boolean;
-        labels?: {
-            from?: string;
-            to?: string;
-        };
-    };
-    facetValueCountLimit?: number;
-    showDocumentCount?: boolean;
-    style?: {
-        type: FacetStyle;
-    };
-    exclude?: string[];
-    expand?: string[];
-    facetFilterQueries?: Record<string, FacetFilterQuery>;
-};
-export declare type SearchResultsFilterOptions = {
-    currentFilters?: ResultCurrentFilterOptions;
-    facets?: ResultFacetOptions;
-    categories?: CategoryFilterOptions;
-};
-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/types/search-results/SearchResultsPagination.d.ts

@@ -1,21 +0,0 @@
-export declare type SearchResultsPaginationLabels = {
-    pageSize: string;
-    showMore?: string;
-    showLess?: string;
-    itemCount: string;
-    filteredItemCount?: string;
-};
-export declare type SearchResultsPagination = {
-    sizeSelection: {
-        sizes: number[];
-        position: SearchResultsPaginationPosition;
-    };
-    pageSelection: {
-        position: SearchResultsPaginationPosition;
-        display: number;
-    };
-};
-export declare type SearchResultsPaginationPosition = {
-    top: boolean;
-    bottom: boolean;
-};

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

@@ -1,24 +0,0 @@
-import { Document } from "@getlupa/client-sdk/Types";
-import { DocumentElement } from "../DocumentElement";
-import { BadgeElement, BadgeGenerateOptions } from "./BadgeOptions";
-import { RoutingBehavior } from "./RoutingBehavior";
-import { SearchResultsOptionLabels } from "./SearchResultsOptions";
-export declare type SearchResultsProductCardOptions = {
-    labels: SearchResultsOptionLabels;
-    routingBehavior?: RoutingBehavior;
-    isInStock: (doc: Document) => boolean;
-    badges: SearchResultBadgeOptions;
-    links: {
-        details: string;
-    };
-    elements: DocumentElement[];
-    queryKey: string;
-    idKey?: string;
-    titleKey?: string;
-};
-export declare type SearchResultBadgeOptions = {
-    anchor: AnchorPosition;
-    elements: BadgeElement[];
-    generate?: BadgeGenerateOptions;
-};
-export declare type AnchorPosition = "tr" | "tl";

package/dist/iife/types/search-results/SearchResultsSort.d.ts

@@ -1,11 +0,0 @@
-import { SortDirection } from "../General";
-export declare type SearchResultsSortOptions = {
-    key: string;
-    label: string;
-    config: Record<string, SortDirection>[];
-    default?: boolean;
-};
-export declare type SortOptions = {
-    label: string;
-    options: SearchResultsSortOptions[];
-};

package/dist/iife/utils/__tests__/debounce.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/event.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/filter.toggle.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/filter.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/history.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/link.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/params.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/picker.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/price.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/query.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/string.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/suggestion.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/__tests__/tracking.utils.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/iife/utils/debounce.utils.d.ts

@@ -1 +0,0 @@
-export declare const debounce: (func: (...args: unknown[]) => unknown, timeout?: number | undefined) => (() => unknown);

package/dist/iife/utils/document.utils.d.ts

@@ -1 +0,0 @@
-export declare const setDocumentTitle: (template: string, textToInsert?: string) => void;

package/dist/iife/utils/event.utils.d.ts

@@ -1,2 +0,0 @@
-export declare const bindSearchTriggers: (triggers: string[] | undefined, event: () => unknown) => void;
-export declare const unbindSearchTriggers: (triggers: string[] | undefined, event: () => unknown) => void;

package/dist/iife/utils/filter.toggle.utils.d.ts

@@ -1,23 +0,0 @@
-import { HierarchyFacetAction, RangeFacetAction, TermFacetAction } from "@/types/search-results/FacetAction";
-import { FilterType } from "@/types/search-results/Filters";
-import { FilterGroup } from "@getlupa/client-sdk/Types";
-declare type AppendParams = ({ params, paramsToRemove, encode, }: {
-    params: {
-        name: string;
-        value: string | string[];
-    }[];
-    paramsToRemove?: string[];
-    encode?: boolean;
-}) => unknown;
-export declare const getFacetKey: (key: string, type: FilterType) => string;
-export declare const getFacetParam: (key: string, value: string[] | string, type?: string) => {
-    name: string;
-    value: string[] | string;
-};
-export declare const toggleTermFilter: (appendParams: AppendParams, facetAction: TermFacetAction, currentFilters?: FilterGroup | undefined) => void;
-export declare const toggleHierarchyFilter: (appendParams: AppendParams, facetAction: HierarchyFacetAction, currentFilters?: FilterGroup | undefined, removeAllLevels?: boolean) => void;
-export declare const toggleRangeFilter: (appendParams: AppendParams, facetAction: RangeFacetAction, currentFilters?: FilterGroup | undefined) => void;
-export declare const toggleTermParam: (params?: string[], param?: string) => string[];
-export declare const toggleLastPram: (params?: string[], param?: string) => string[];
-export declare const toggleHierarchyParam: (params?: string[], param?: string, removeAllLevels?: boolean) => string[];
-export {};

package/dist/iife/utils/filter.utils.d.ts

@@ -1,11 +0,0 @@
-import { LabeledFilter, UnfoldedFilter } from "@/types/search-results/Filters";
-import { FacetResult, FilterGroup, FilterGroupItemTypeRange, HierarchyTree } from "@getlupa/client-sdk/Types";
-export declare const formatRange: (filter: FilterGroupItemTypeRange) => string;
-export declare const unfoldFilters: (filters?: FilterGroup | undefined) => UnfoldedFilter[];
-export declare const getLabeledFilters: (filters: UnfoldedFilter[], facets?: FacetResult[] | undefined) => LabeledFilter[];
-export declare const isFacetKey: (key: string) => boolean;
-export declare const isArrayKey: (key: string) => boolean;
-export declare const getMostSpecificHierarchyTerms: (terms: string[]) => string[];
-export declare const recursiveFilter: (items: HierarchyTree[], query?: string) => HierarchyTree[];
-export declare const recursiveFilterItem: (item: HierarchyTree, query?: string) => HierarchyTree | undefined;
-export declare const rangeFilterToString: (rangeFilter: FilterGroupItemTypeRange, separator?: string | undefined) => string;

package/dist/iife/utils/history.utils.d.ts

@@ -1,2 +0,0 @@
-export declare const retrieveHistory: () => string[];
-export declare const saveHistory: (items: string[]) => void;

package/dist/iife/utils/link.utils.d.ts

@@ -1,6 +0,0 @@
-import { InputSuggestionFacet } from "@/types/search-box/Common";
-export declare const generateLink: (linkPattern: string, document: Record<string, unknown>) => string;
-export declare const generateResultLink: (link: string, searchText?: string | undefined, facet?: InputSuggestionFacet | undefined) => string;
-export declare const getPathName: (resultPageLink: string) => string;
-export declare const getRelativePath: (link: string) => string;
-export declare const linksMatch: (link1?: string | undefined, link2?: string | undefined) => boolean;

package/dist/iife/utils/merger.utils.d.ts

@@ -1 +0,0 @@
-export declare const merge: <A extends Record<string, any>, B extends Record<string, any>>(target: A, source: B) => A & B;

package/dist/iife/utils/params.utils.d.ts

@@ -1,9 +0,0 @@
-import { QueryParams } from "@/types/search-results/QueryParams";
-export declare const parseParams: (searchParams?: URLSearchParams | undefined) => QueryParams;
-export declare const appendParam: (url: URL, { name, value }: {
-    name: string;
-    value: string | string[];
-}, encode?: boolean) => void;
-export declare const getRemovableParams: (url: URL, paramsToRemove?: string[] | "all" | undefined) => string[] | undefined;
-export declare const removeParams: (url: URL, params?: string[]) => void;
-export declare const encodeParam: (param: string) => string;

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

@@ -1,5 +0,0 @@
-export declare const pick: <T extends Record<string, unknown>, U extends keyof T>(obj: T, keys: U[]) => Pick<T, U>;
-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;

package/dist/iife/utils/price.utils.d.ts

@@ -1,2 +0,0 @@
-export declare const formatPrice: (price?: string | number | undefined, currency?: string, separator?: string) => string;
-export declare const formatPriceSummary: ([min, max]: [min?: string | number | undefined, max?: string | number | undefined], currency?: string | undefined, separator?: string) => string;

package/dist/iife/utils/query.utils.d.ts

@@ -1,5 +0,0 @@
-import { QueryParams } from "@/types/search-results/QueryParams";
-import { SearchResultsSortOptions } from "@/types/search-results/SearchResultsSort";
-import { FilterGroup, PublicQuery } from "@getlupa/client-sdk/Types";
-export declare const createPublicQuery: (queryParams: QueryParams, sortOptions?: SearchResultsSortOptions[] | undefined, defaultPageSize?: number | undefined) => PublicQuery;
-export declare const getPublicQuery: (publicQuery: PublicQuery, initialFilters: FilterGroup, isProductList: boolean) => PublicQuery;

package/dist/iife/utils/routing.utils.d.ts

@@ -1,6 +0,0 @@
-import { InputSuggestionFacet } from "@/types/search-box/Common";
-import { RoutingBehavior } from "..";
-export declare const emitRoutingEvent: (url: string) => void;
-export declare const handleRoutingEvent: (link: string, event?: Event | undefined, hasEventRouting?: boolean) => void;
-export declare const redirectToResultsPage: (link: string, searchText: string, facet?: InputSuggestionFacet | undefined, routingBehavior?: RoutingBehavior) => void;
-export declare const getPageUrl: (pathnameOverride?: string | undefined) => URL;

package/dist/iife/utils/scroll.utils.d.ts

@@ -1,4 +0,0 @@
-export declare const scrollToSearchResults: (timeout?: number) => void;
-export declare const scrollTo: (elementId: string) => void;
-export declare const disableBodyScroll: () => void;
-export declare const enableBodyScroll: () => void;

package/dist/iife/utils/string.utils.d.ts

@@ -1,9 +0,0 @@
-import { Document } from "@getlupa/client-sdk/Types";
-export declare const getNormalizedString: (str?: string | number | undefined) => string;
-export declare const capitalize: (str?: string | undefined) => string;
-export declare const addParamsToLabel: (label: string, ...params: unknown[]) => string;
-export declare const getRandomString: (length: number) => string;
-export declare const getDisplayValue: (value?: string | number | undefined) => string;
-export declare const getProductKey: (index: string, product: Document, idKey: string | undefined) => string;
-export declare const normalizeFloat: (value?: string | undefined) => number;
-export declare const escapeHtml: (value?: string | undefined) => string;

package/dist/iife/utils/suggestion.utils.d.ts

@@ -1,3 +0,0 @@
-import { DisplaySuggestion } from "@/types/search-box/Common";
-import { Suggestion } from "@getlupa/client-sdk/Types";
-export declare const flattenSuggestions: (suggestions: Suggestion[], inputValue: string) => DisplaySuggestion[];

package/dist/iife/utils/tracking.utils.d.ts

@@ -1,9 +0,0 @@
-import { TrackingOptions } from "@/types/General";
-import { TrackableEventData } from "@/types/search-box/Common";
-import { Options } from "@getlupa/client-sdk/Types";
-export declare const initTracking: (options: TrackingOptions) => void;
-export declare const getLupaTrackingContext: () => {
-    userId?: string;
-    sessionId?: string;
-};
-export declare const track: (queryKey?: string | undefined, data?: TrackableEventData, options?: Options | undefined) => void;