@depict-ai/ui 1.3.5 → 1.3.7

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { SearchRequest, SearchFilter } from "@depict-ai/types/api/SearchRequest"
 import { BaseSearchRequest } from "@depict-ai/types/api/BaseSearchRequest";
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
-export const version = "1.3.5";
+export const version = "1.3.7";
 declare class SDKError extends Error {
 }
 export class ProductCardError extends SDKError {
@@ -400,7 +400,9 @@ type GeneralCategoryListingOptions = {
     market: string;
     merchant: string;
     localization: category_i18n;
+    unique_instance_key_for_state?: string;
     on_navigation?: OnNavigation;
+    query_id_state_key?: string;
 };
 type CategoryConstructorOptionsWithApi<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = GeneralCategoryListingOptions & {
     api: DepictAPI<InputDisplay, OutputDisplay>;
@@ -431,7 +433,7 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
     set listing_type(listing_type: ListingType | undefined);
     get on_navigation(): OnNavigation;
     set on_navigation(new_function: OnNavigation);
-    constructor({ api, on_navigation, page_url_creator, ...props_on_class }: DepictCategoryConstructorOptions<InputDisplay, OutputDisplay>);
+    constructor({ api, on_navigation, page_url_creator, unique_instance_key_for_state, query_id_state_key, ...props_on_class }: DepictCategoryConstructorOptions<InputDisplay, OutputDisplay>);
 }
 export function CategoryPage<OriginalDisplay extends Display, OutputDisplay extends ModernDisplay | never>(props: {
     depict_category: DepictCategory<OriginalDisplay, OutputDisplay>;
@@ -511,6 +513,7 @@ type GeneralConstructorOptions<InputDisplay extends Display, OutputDisplay exten
     on_navigation?: OnNavigation;
     url_transformer?: (url_object: URL) => unknown;
     enable_category_suggestions?: boolean;
+    unique_instance_key_for_state?: string;
     disable_scrolling_during_modal?: boolean;
     bottom_distance_under_modal?: Accessor<number | undefined>;
     render_instant_card?: InstantCard<OutputDisplay extends ModernDisplay ? OutputDisplay : InputDisplay>;
@@ -537,7 +540,7 @@ export type OpenModalArguments = [
 export const get_search_query_updating_blocked_signal: (depict_search: DepictSearch<any>) => Signal<boolean> | undefined;
 export class DepictSearch<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
     #private;
-    constructor({ search_query_url_param_name: search_query_url_param_name_, url_transformer, on_navigation, enable_category_suggestions, page_url_creator, disable_scrolling_during_modal, api, bottom_distance_under_modal, render_instant_card, ...props_on_class }: ConstructorOptions<InputDisplay, OutputDisplay>);
+    constructor({ unique_instance_key_for_state, search_query_url_param_name: search_query_url_param_name_, url_transformer, on_navigation, enable_category_suggestions, page_url_creator, disable_scrolling_during_modal, api, bottom_distance_under_modal, render_instant_card, ...props_on_class }: ConstructorOptions<InputDisplay, OutputDisplay>);
     get on_navigation(): OnNavigation;
     set on_navigation(new_function: OnNavigation);
     get localization(): search_i18n;
@@ -595,6 +598,12 @@ export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformed
      * Custom metadata to be sent with each request to the Depict API. Only necessary if specifically instructed by Depict.
      */
     metaData?: Record<string, string>;
+    /**
+     * You can't have more than one instance of the same provider on the same page, unless you specify a unique instance key for each one.
+     * We recommend to just use an incrementing number for this, e.g. "1", "2", "3", ...
+     * TODO: more explanation
+     */
+    uniqueInstanceKeyForState?: string;
 } & (InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
     pageURLCreator?: PageURLCreator<InputDisplay, PossibleTransformedDisplay>;
 } : {