@getlupa/vue 0.9.6 → 0.10.1

package/dist/src/constants/queryParams.const.d.ts

@@ -1,9 +1,5 @@
-export declare const QUERY_PARAMS: {
-    QUERY: string;
-    PAGE: string;
-    LIMIT: string;
-    SORT: string;
-};
+import { LupaQueryParamName, LupaQueryParamValue } from '../types/General';
+export declare const QUERY_PARAMS: Record<LupaQueryParamName, LupaQueryParamValue>;
 export declare const QUERY_PARAMS_PARSED: {
     QUERY: string;
     PAGE: string;

package/dist/src/stores/dynamicData.d.ts

@@ -3,13 +3,15 @@ import type { SearchQueryResult } from '@getlupa/client-sdk/Types';
 export declare const useDynamicDataStore: import("pinia").StoreDefinition<"dynamicData", import("pinia")._UnwrapAll<Pick<{
     dynamicDataIdMap: Ref<Record<string, Document>>;
     loading: Ref<boolean>;
+    loadingIds: Ref<Record<string, boolean>>;
     enhanceSearchResultsWithDynamicData: ({ result, mode }: {
         result?: SearchQueryResult;
         mode?: 'searchBox' | 'searchResults';
     }) => Promise<{}>;
-}, "dynamicDataIdMap" | "loading">>, Pick<{
+}, "dynamicDataIdMap" | "loading" | "loadingIds">>, Pick<{
     dynamicDataIdMap: Ref<Record<string, Document>>;
     loading: Ref<boolean>;
+    loadingIds: Ref<Record<string, boolean>>;
     enhanceSearchResultsWithDynamicData: ({ result, mode }: {
         result?: SearchQueryResult;
         mode?: 'searchBox' | 'searchResults';
@@ -17,6 +19,7 @@ export declare const useDynamicDataStore: import("pinia").StoreDefinition<"dynam
 }, never>, Pick<{
     dynamicDataIdMap: Ref<Record<string, Document>>;
     loading: Ref<boolean>;
+    loadingIds: Ref<Record<string, boolean>>;
     enhanceSearchResultsWithDynamicData: ({ result, mode }: {
         result?: SearchQueryResult;
         mode?: 'searchBox' | 'searchResults';

package/dist/src/stores/options.d.ts

@@ -1,7 +1,7 @@
 import { type Ref } from 'vue';
 import type { SearchBoxOptions } from '../types/search-box/SearchBoxOptions';
 import type { SearchResultsOptions } from '../types/search-results/SearchResultsOptions';
-import type { TrackingOptions } from '../types/General';
+import type { LupaQueryParamValue, TrackingOptions } from '../types/General';
 import type { FilterGroup } from '@getlupa/client-sdk/Types';
 export declare const useOptionsStore: import("pinia").StoreDefinition<"options", import("pinia")._UnwrapAll<Pick<{
     searchBoxOptions: Ref<SearchBoxOptions>;
@@ -26,6 +26,7 @@ export declare const useOptionsStore: import("pinia").StoreDefinition<"options",
     setInitialFilters: ({ initialFilters }: {
         initialFilters: FilterGroup;
     }) => void;
+    getQueryParamName: (param: LupaQueryParamValue) => string;
 }, "searchBoxOptions" | "searchResultOptions" | "trackingOptions">>, Pick<{
     searchBoxOptions: Ref<SearchBoxOptions>;
     searchResultOptions: Ref<SearchResultsOptions>;
@@ -49,6 +50,7 @@ export declare const useOptionsStore: import("pinia").StoreDefinition<"options",
     setInitialFilters: ({ initialFilters }: {
         initialFilters: FilterGroup;
     }) => void;
+    getQueryParamName: (param: LupaQueryParamValue) => string;
 }, "initialFilters" | "envOptions" | "classMap" | "boxRoutingBehavior" | "searchResultsRoutingBehavior" | "defaultSearchResultPageSize" | "currentResolutionPageSizes">, Pick<{
     searchBoxOptions: Ref<SearchBoxOptions>;
     searchResultOptions: Ref<SearchResultsOptions>;
@@ -72,4 +74,5 @@ export declare const useOptionsStore: import("pinia").StoreDefinition<"options",
     setInitialFilters: ({ initialFilters }: {
         initialFilters: FilterGroup;
     }) => void;
-}, "setSearchBoxOptions" | "setTrackingOptions" | "setSearchResultOptions" | "setInitialFilters">>;
+    getQueryParamName: (param: LupaQueryParamValue) => string;
+}, "setSearchBoxOptions" | "setTrackingOptions" | "setSearchResultOptions" | "setInitialFilters" | "getQueryParamName">>;

package/dist/src/stores/screen.d.ts

@@ -1,20 +1,20 @@
 export declare const useScreenStore: import("pinia").StoreDefinition<"screen", import("pinia")._UnwrapAll<Pick<{
     screenWidth: import("vue").Ref<number>;
-    currentScreenWidth: import("vue").ComputedRef<"xs" | "sm" | "md" | "l" | "xl">;
+    currentScreenWidth: import("vue").ComputedRef<"l" | "xs" | "sm" | "md" | "xl">;
     isMobileWidth: import("vue").ComputedRef<boolean>;
     setScreenWidth: ({ width }: {
         width: number;
     }) => void;
 }, "screenWidth">>, Pick<{
     screenWidth: import("vue").Ref<number>;
-    currentScreenWidth: import("vue").ComputedRef<"xs" | "sm" | "md" | "l" | "xl">;
+    currentScreenWidth: import("vue").ComputedRef<"l" | "xs" | "sm" | "md" | "xl">;
     isMobileWidth: import("vue").ComputedRef<boolean>;
     setScreenWidth: ({ width }: {
         width: number;
     }) => void;
 }, "currentScreenWidth" | "isMobileWidth">, Pick<{
     screenWidth: import("vue").Ref<number>;
-    currentScreenWidth: import("vue").ComputedRef<"xs" | "sm" | "md" | "l" | "xl">;
+    currentScreenWidth: import("vue").ComputedRef<"l" | "xs" | "sm" | "md" | "xl">;
     isMobileWidth: import("vue").ComputedRef<boolean>;
     setScreenWidth: ({ width }: {
         width: number;

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

@@ -19,3 +19,5 @@ export type TrackingOptions = {
 export type Environment = SdkEnvironment;
 export type SortDirection = 'asc' | 'desc';
 export type ScreenSize = 'xs' | 'sm' | 'md' | 'l' | 'xl';
+export type LupaQueryParamName = 'QUERY' | 'PAGE' | 'LIMIT' | 'SORT';
+export type LupaQueryParamValue = 'q' | 'p' | 'l' | 's';

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

@@ -0,0 +1,6 @@
+import { BadgeElement, BadgeGenerateOptions } from '../search-results/BadgeOptions';
+export type SearchBoxBadgeOptions = {
+    elements: BadgeElement[];
+    generate?: BadgeGenerateOptions;
+    anchorElementKey: string;
+};

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

@@ -1,5 +1,5 @@
 import { SearchQueryResult } from '@getlupa/client-sdk/Types';
-import type { SdkOptions } from '../General';
+import type { LupaQueryParamValue, SdkOptions } from '../General';
 import type { RoutingBehavior } from '../search-results/RoutingBehavior';
 import type { DynamicData } from '../search-results/SearchResultsOptions';
 import type { SearchBoxHistory } from './SearchBoxHistory';
@@ -14,6 +14,7 @@ export type SearchBoxOptions = SearchBoxPanelOptions & {
     dynamicData?: DynamicData;
     callbacks?: SearchBoxEventCallbacks;
     redirections?: RedirectionOptions;
+    queryParameterNames?: Record<LupaQueryParamValue, string>;
 };
 export type SearchBoxOptionLabels = {
     placeholder: string;

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

@@ -1,6 +1,7 @@
 import type { DocumentElement } from '../DocumentElement';
 import type { Document } from '@getlupa/client-sdk/Types';
 import { CustomDocumentHtmlAttributes } from '../General';
+import { SearchBoxBadgeOptions } from './SearchBoxBadgeOptions';
 export declare enum SearchBoxPanelType {
     SUGGESTION = "suggestion",
     DOCUMENT = "document",
@@ -30,6 +31,7 @@ export type DocumentSearchBoxPanel = SearchBoxPanelBase & {
     idKey?: string;
     customClassName?: string;
     searchBySuggestion?: boolean;
+    badges?: SearchBoxBadgeOptions;
     isInStock?: (doc: Document) => boolean;
     customDocumentHtmlAttributes?: CustomDocumentHtmlAttributes;
 };

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

@@ -15,10 +15,11 @@ export type BadgeGenerateOptions<T = Record<string, any>> = {
     customClass?: (field: BadgeGenerateSeed) => string | undefined;
 };
 export type BadgeOptions = {
-    anchor: AnchorPosition;
+    anchor?: AnchorPosition;
     elements: BadgeElement[];
     generate?: BadgeGenerateOptions;
     product?: any;
+    anchorElementKey?: string;
 };
 export type SearchResultBadgeElement<T = any> = {
     type: SearchResultBadgeType;

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

@@ -1,6 +1,7 @@
 import type { HierarchyFacetAction, RangeFacetAction, TermFacetAction } from '../types/search-results/FacetAction';
 import type { FilterType } from '../types/search-results/Filters';
 import type { FilterGroup } from '@getlupa/client-sdk/Types';
+import { LupaQueryParamValue } from '../types/General';
 type AppendParams = ({ params, paramsToRemove, encode }: {
     params: {
         name: string;
@@ -14,9 +15,9 @@ export declare const getFacetParam: (key: string, value: string[] | string, type
     name: string;
     value: string[] | string;
 };
-export declare const toggleTermFilter: (appendParams: AppendParams, facetAction: TermFacetAction, currentFilters?: FilterGroup) => void;
-export declare const toggleHierarchyFilter: (appendParams: AppendParams, facetAction: HierarchyFacetAction, currentFilters?: FilterGroup, removeAllLevels?: boolean) => void;
-export declare const toggleRangeFilter: (appendParams: AppendParams, facetAction: RangeFacetAction, currentFilters?: FilterGroup) => void;
+export declare const toggleTermFilter: (appendParams: AppendParams, facetAction: TermFacetAction, getQueryParamName?: (param: LupaQueryParamValue) => string, currentFilters?: FilterGroup) => void;
+export declare const toggleHierarchyFilter: (appendParams: AppendParams, facetAction: HierarchyFacetAction, getQueryParamName?: (param: LupaQueryParamValue) => string, currentFilters?: FilterGroup, removeAllLevels?: boolean) => void;
+export declare const toggleRangeFilter: (appendParams: AppendParams, facetAction: RangeFacetAction, getQueryParamName?: (param: LupaQueryParamValue) => string, currentFilters?: FilterGroup) => 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[];

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

@@ -1,6 +1,7 @@
 import type { InputSuggestionFacet } from '../types/search-box/Common';
+import { LupaQueryParamValue } from '../types/General';
 export declare const generateLink: (linkPattern: string, document: Record<string, unknown>) => string;
-export declare const generateResultLink: (link: string, searchText?: string, facet?: InputSuggestionFacet) => string;
+export declare const generateResultLink: (link: string, getQueryParamName?: (param: LupaQueryParamValue) => string, searchText?: string, facet?: InputSuggestionFacet) => string;
 export declare const getPathName: (resultPageLink: string) => string;
 export declare const getRelativePath: (link: string) => string;
 export declare const linksMatch: (link1?: string, link2?: string) => boolean;

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

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

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

@@ -1,6 +1,7 @@
 import type { InputSuggestionFacet } from '../types/search-box/Common';
 import type { RoutingBehavior, SsrOptions } from '..';
+import { LupaQueryParamValue } from '../types/General';
 export declare const emitRoutingEvent: (url: string) => void;
 export declare const handleRoutingEvent: (link: string, event?: Event, hasEventRouting?: boolean) => void;
-export declare const redirectToResultsPage: (link: string, searchText: string, facet?: InputSuggestionFacet, routingBehavior?: RoutingBehavior) => void;
+export declare const redirectToResultsPage: (link: string, searchText: string, getQueryParamName: (param: LupaQueryParamValue) => string, facet?: InputSuggestionFacet, routingBehavior?: RoutingBehavior) => void;
 export declare const getPageUrl: (pathnameOverride?: string, ssr?: SsrOptions) => URL;

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

@@ -1,7 +1,8 @@
 import { SearchResultsOptions } from '..';
 import { FilterGroup } from '@getlupa/client-sdk/Types';
+import { LupaQueryParamValue } from '../types/General';
 export declare const getSearchParams: (url?: string, params?: URLSearchParams, baseUrl?: string) => URLSearchParams;
-export declare const getInitialSearchResults: (options: SearchResultsOptions, defaultData?: {
+export declare const getInitialSearchResults: (options: SearchResultsOptions, getQueryParamName: (param: LupaQueryParamValue) => string, defaultData?: {
     filters?: FilterGroup;
     pageSize?: number;
 }) => Promise<import("@getlupa/client-sdk/Types").SearchQueryResult | import("@getlupa/client-sdk/Types").SdkError>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getlupa/vue",
-  "version": "0.9.6",
+  "version": "0.10.1",
   "main": "dist/lupaSearch.mjs",
   "module": "dist/lupaSearch.mjs",
   "types": "dist/src/index.d.ts",