@depict-ai/ui 0.0.71 → 0.0.73

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { BaseSearchRequest } from "@depict-ai/types/api/BaseSearchRequest";
 import { SearchSuggestionsResponse, CategorySuggestion } from "@depict-ai/types/api/SearchSuggestionsResponse";
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
-import { ProductListingResponse, BaseCategoryDisplay } from "@depict-ai/types/api/ProductListingResponse";
-export const version = "0.0.71";
+import { ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
+export const version = "0.0.73";
 type ExclusiveId = {
     categoryId: string;
     productId?: undefined;
@@ -176,13 +176,13 @@ export class DepictAPI {
  * Use `javascript_media_query` but return a reactive accessor instead of taking a callback function
  */
 export function media_query_to_accessor(media_query: string): import("solid-js").Accessor<boolean>;
-export type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
 export type SDKGridSpacing = string | {
     horizontal: string;
     vertical: string;
 };
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
 export function show_toast({ children, on_close_, close_after_, ...more_attributes }: {
     children?: JSX.Element;
     close_after_: number;
@@ -200,6 +200,10 @@ export class ProductCardError extends SDKError {
  * @returns A cleanup function to manually re-enable scrolling.
  */
 export function disable_scrolling(): () => void;
+type OnNavigation = ((options: {
+    is_replace: boolean;
+    new_url: URL;
+}) => void) | "hard_navigation";
 export const CategoryTitle: ({ category_title_, product_count_, }: {
     category_title_: Accessor<string | undefined>;
     product_count_: JSX.Element;
@@ -236,7 +240,7 @@ type DepictCategoryConstructorOptions = {
     market: string;
     merchant: string;
     localization: category_i18n;
-    on_navigation: (relative_url: string, ev: MouseEvent, display: BaseCategoryDisplay) => unknown;
+    on_navigation?: OnNavigation;
     api?: DepictAPI;
 };
 export class DepictCategory {
@@ -249,6 +253,8 @@ export class DepictCategory {
     set merchant(merchant: string);
     get market(): string;
     set market(market: string);
+    get on_navigation(): OnNavigation;
+    set on_navigation(new_function: OnNavigation);
     constructor({ api, on_navigation, ...props_on_class }: DepictCategoryConstructorOptions);
 }
 export function CategoryPage<T extends Display>({ depict_category, grid_spacing, cols_at_size, product_card_template, get_product_id, show_breadcrumbs, show_quicklinks, category_title, }: {
@@ -279,20 +285,12 @@ export function DefaultInstantCardPlaceholder(): HTMLDivElement;
  * @returns a function that can be called any time to re-run the alignment routine in case that the elements have gone out of alignment
  */
 export function align_field(modal_body_style: Signal<JSX.CSSProperties>, input_field: HTMLElement, width_transformer?: (arg0: number) => number, includeScroll?: boolean, one_axies_only?: "top" | "left"): () => void;
-/**
- * Calls history.pushState wiht the current url BUT the query parameter with name url_param_name has been set to value (or deleted if no value is provided) and url_transformer has been executed on the URL object that we're pushing
- */
-export function push_state_with_query_param_value(url_param_name: string, value?: string, url_transformer?: (url_object: URL) => unknown): void;
 interface Styles {
     [selector: string]: JSX.CSSProperties;
 }
 export const styles_to_valid_css_string: (styles: Styles) => string;
 /** A function that renders category suggestion cards. Set to false to disable category suggestions. */
-export type RenderCategorySuggestion = (category_suggestion: Accessor<CategorySuggestion>, index: number, selected_filters_: Signal<{
-    field: WithRequired<SearchFilter, "field">["field"];
-    op: WithRequired<SearchFilter, "op">["op"];
-    data: WithRequired<SearchFilter, "data">["data"];
-}[]>) => JSX.Element;
+export type RenderCategorySuggestion = (category_suggestion: Accessor<CategorySuggestion>, index: number) => JSX.Element;
 /**
  * Connects the height of the search field to the height of the aligner.
  * @param aligner
@@ -306,7 +304,7 @@ type ConstructorOptions<T extends Display> = {
     market: string;
     merchant: string;
     localization: search_i18n;
-    on_navigation?: (relative_url: string) => unknown;
+    on_navigation?: OnNavigation;
     url_transformer?: (url_object: URL) => unknown;
     enable_category_suggestions?: boolean;
     disable_scrolling_during_modal?: boolean;
@@ -327,7 +325,9 @@ type OpenModalArguments = [
 export const get_search_query_updating_blocked_signal: (depict_search: DepictSearch<any>) => Signal<boolean> | undefined;
 export class DepictSearch<T extends Display> {
     #private;
-    constructor({ search_query_url_param_name, url_transformer, on_navigation: raw_on_navigation, enable_category_suggestions, disable_scrolling_during_modal, api, bottom_distance_under_modal_, render_instant_card, ...props_on_class }: ConstructorOptions<T>);
+    constructor({ search_query_url_param_name, url_transformer, on_navigation, enable_category_suggestions, disable_scrolling_during_modal, api, bottom_distance_under_modal_, render_instant_card, ...props_on_class }: ConstructorOptions<T>);
+    get on_navigation(): OnNavigation;
+    set on_navigation(new_function: OnNavigation);
     get localization(): search_i18n;
     set localization(locale_obj: search_i18n);
     get modal_open(): OpenModalArguments | boolean;
@@ -381,8 +381,8 @@ export type BaseSearchProviderConfig = {
     searchPagePath: string;
     /**
      * The name of the url parameter that will be used for the search query.
-     * @example "q", "search_query"
-     * @default "search_query"
+     * @example "q", "search_query", "query"
+     * @default "query"
      */
     urlParamName?: string;
     /**