@depict-ai/ui 1.4.4 → 1.4.6

package/server/latest/index.d.ts

@@ -1,13 +1,13 @@
 import { JSX, Signal, Accessor, Setter } from "solid-js";
 import { Elem, Display, ColsAtSize, ModernDisplay, Node_Array } from "@depict-ai/utilishared/latest";
 import { SearchFilter, SearchRequest } from "@depict-ai/types/api/SearchRequest";
-import { SearchFilter as _SearchFilter1, SearchResponse } from "@depict-ai/types/api/SearchResponse";
+import { SearchFilter as _SearchFilter1, ContentLink, SearchResponse } from "@depict-ai/types/api/SearchResponse";
 import { BaseCategoryDisplay, ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
 import { CategorySuggestion, SearchSuggestionsResponse } from "@depict-ai/types/api/SearchSuggestionsResponse";
 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.4.4";
+export const version = "1.4.6";
 export function ExpandingDetails(props: {
   details_: HTMLDetailsElement;
   summary_: HTMLElement;
@@ -76,11 +76,13 @@ interface search_i18n extends plp_shared_i18n {
   placeholder_text_: string;
   show_n_results_: (number_of_results: HTMLElement) => Elem[];
   no_results_text_: string;
+  no_products_: string;
   search_recs_title_: string;
   clear_filters_query_sorting_after_submit_: string;
   modal_view_all_results_: (number_of_results: HTMLElement) => Elem[];
   modal_discover_more_: string;
-  get_showing_results_for_: (query: HTMLElement, number_of_results: HTMLElement) => Elem[];
+  get_showing_results_for_: (query: HTMLElement, number_of_results_element: HTMLElement, has_query: boolean, number_of_results: number | undefined) => Elem[];
+  get_showing_pages_for_: (query: HTMLElement, number_of_results_element: HTMLElement, has_query: boolean, number_of_results: number | undefined) => Elem[];
   previous_searches_text_: string;
   category_: string;
   brand_: string;
@@ -88,6 +90,7 @@ interface search_i18n extends plp_shared_i18n {
   search_submit_button_aria_label_: string;
   search_field_field_aria_label_: string;
   previous_searches_delete_entry_from_history_: string;
+  content_: string;
 }
 /**
  * Category internationalisation
@@ -240,6 +243,7 @@ export type SolidLayoutOptions = {
     currently_visible?: Signal<number>;
     max_rows?: number;
     button?: JSX.Element;
+    view_less_button?: JSX.Element;
   } | "all";
   layout: "slider" | "grid";
   disable_partial_rows?: boolean;
@@ -257,6 +261,47 @@ export type SolidLayoutOptions = {
  * @return An accessor containing a CSS string
  */
 export function SolidLayout(props: SolidLayoutOptions): JSX.Element;
+type DisplayTransformerAlwaysThereData = {
+  merchant: string;
+  market: string;
+};
+type CanBePromiseWrapped<T> = T | Promise<T>;
+export type ModernDisplayWithPageUrl<T extends ModernDisplay> = { [K in keyof T]: K extends "variant_displays" ? (T[K][number] & {
+  page_url: string;
+})[] : T[K] };
+/**
+ * DisplayTransformers supersede pageURLCreator
+ * DisplayTransformers are functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+ */
+export type DisplayTransformers<InputDisplay extends ModernDisplay, OutputDisplay extends ModernDisplay | never> = {
+  products?: (options: DisplayTransformerAlwaysThereData & {
+    displays: InputDisplay[];
+  }) => CanBePromiseWrapped<OutputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<OutputDisplay>[] : never>;
+  categories?: (options: DisplayTransformerAlwaysThereData & {
+    data: (BaseCategoryDisplay | CategorySuggestion)[];
+  }) => CanBePromiseWrapped<{
+    page_url: string;
+  }[]>;
+  contentResults?: (options: DisplayTransformerAlwaysThereData & {
+    data: ContentLink[];
+  }) => CanBePromiseWrapped<ContentLink[]>;
+};
+export type SomethingTakingAPageURLCreatorOrDisplayTransformers<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
+  page_url_creator?: PageURLCreator<InputDisplay, OutputDisplay>;
+  display_transformers?: never;
+} | {
+  page_url_creator?: never;
+  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
+} : {
+  page_url_creator: PageURLCreator<InputDisplay, OutputDisplay>;
+  display_transformers?: never;
+} | {
+  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
+  page_url_creator?: never;
+} : {
+  page_url_creator?: never;
+  display_transformers?: never;
+};
 type PageURLCreatorAlwaysThereData = {
   merchant: string;
   market: string;
@@ -269,12 +314,9 @@ type PageURLCreatorProductData<T extends ModernDisplay> = {
   displays: T[];
   type: "products";
 };
-type CanBePromiseWrapped<T> = T | Promise<T>;
-export type ModernDisplayWithPageUrl<T extends ModernDisplay> = { [K in keyof T]: K extends "variant_displays" ? (T[K][number] & {
-  page_url: string;
-})[] : T[K] };
 type PageURLCreatorOptions<InputDisplay extends ModernDisplay> = PageURLCreatorAlwaysThereData & (PageURLCreatorCategoryData | PageURLCreatorProductData<InputDisplay>);
 /**
+ * @deprecated use DisplayTransformers instead
  * PageUrlCreator is, in its most basic form, a function that takes in a list of categories or products and returns a list of page_urls for the provided categories or products.
  * It's main use case is to allow for the creation of links to the product or category pages on the merchant's site.
  * It can also be used for the depict customers which already have links to change those links (i.e. for staging sites).
@@ -285,13 +327,6 @@ export type PageURLCreator<InputDisplay extends ModernDisplay, OutputDisplay ext
 }[]> : CanBePromiseWrapped<{
   page_url: string;
 }[]> | CanBePromiseWrapped<OutputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<OutputDisplay>[] : never>;
-export type SomethingTakingAPageURLCreator<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
-  page_url_creator?: PageURLCreator<InputDisplay, OutputDisplay>;
-} : {
-  page_url_creator: PageURLCreator<InputDisplay, OutputDisplay>;
-} : {
-  page_url_creator?: never;
-};
 /**
  * Basically allows you to use SearchModal
  * So the idea is to have a modal. It should either be rendered and exist, in which case it is in the foreground and open, or it's completely gone. This makes things easier.
@@ -412,7 +447,7 @@ type DepictAPIConstructorOptions<InputDisplay extends Display, OutputDisplay ext
   } | undefined>;
   get_user_id?: () => string | undefined;
   get_session_id?: () => string | undefined;
-} & SomethingTakingAPageURLCreator<InputDisplay, OutputDisplay>;
+} & SomethingTakingAPageURLCreatorOrDisplayTransformers<InputDisplay, OutputDisplay>;
 /**
  * Class that handles all communication done in PLP code with the Depict API. (Notably not for recommendations currently).
  * It handles caching, retries and errors and is the only place that should be making requests to the Depict API.
@@ -420,6 +455,7 @@ type DepictAPIConstructorOptions<InputDisplay extends Display, OutputDisplay ext
 export class DepictAPI<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
   page_url_creator: PageURLCreator<ModernDisplay, OutputDisplay> | undefined;
+  display_transformers: DisplayTransformers<ModernDisplay, OutputDisplay> | undefined;
   constructor(options: DepictAPIConstructorOptions<InputDisplay, OutputDisplay>);
   suggest(input_req: SearchSuggestionsRequest): Promise<SearchSuggestionsResponseAfterURLCreator & {
     failed?: true;
@@ -494,16 +530,11 @@ type CategoryConstructorOptionsWithApi<InputDisplay extends Display, OutputDispl
   api: DepictAPI<InputDisplay, OutputDisplay>;
 } & {
   page_url_creator?: never;
+  display_transformers?: never;
 };
 type CategoryConstructorOptionsWithoutApi<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = GeneralCategoryListingOptions & {
   api?: never;
-} & (InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
-  page_url_creator?: PageURLCreator<InputDisplay, OutputDisplay>;
-} : {
-  page_url_creator: PageURLCreator<InputDisplay, OutputDisplay>;
-} : {
-  page_url_creator?: never;
-});
+} & SomethingTakingAPageURLCreatorOrDisplayTransformers<InputDisplay, OutputDisplay>;
 type DepictCategoryConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = CategoryConstructorOptionsWithApi<InputDisplay, OutputDisplay> | CategoryConstructorOptionsWithoutApi<InputDisplay, OutputDisplay>;
 export class DepictCategory<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
@@ -523,6 +554,7 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
     api,
     on_navigation,
     page_url_creator,
+    display_transformers,
     unique_instance_key_for_state,
     query_id_state_key,
     ...props_on_class
@@ -608,6 +640,7 @@ type GeneralConstructorOptions<InputDisplay extends Display, OutputDisplay exten
   on_navigation?: OnNavigation;
   url_transformer?: (url_object: URL) => unknown;
   enable_category_suggestions?: boolean;
+  enable_content_search?: boolean;
   unique_instance_key_for_state?: string;
   disable_scrolling_during_modal?: boolean;
   bottom_distance_under_modal?: Accessor<number | undefined>;
@@ -617,10 +650,11 @@ type ConstructorOptionsWithApi<InputDisplay extends Display, OutputDisplay exten
   api: DepictAPI<InputDisplay, OutputDisplay>;
 } & {
   page_url_creator?: never;
+  display_transformers?: never;
 };
 type ConstructorOptionsWithoutAPI<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = GeneralConstructorOptions<InputDisplay, OutputDisplay> & {
   api?: never;
-} & SomethingTakingAPageURLCreator<InputDisplay, OutputDisplay>;
+} & SomethingTakingAPageURLCreatorOrDisplayTransformers<InputDisplay, OutputDisplay>;
 type ConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = ConstructorOptionsWithApi<InputDisplay, OutputDisplay> | ConstructorOptionsWithoutAPI<InputDisplay, OutputDisplay>;
 export type OpenModalArguments = [options_for_modal?: {
   style_props_?: Signal<JSX.CSSProperties>;
@@ -639,12 +673,15 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
     on_navigation,
     enable_category_suggestions,
     page_url_creator,
-    disable_scrolling_during_modal,
+    display_transformers,
     api,
+    disable_scrolling_during_modal,
     bottom_distance_under_modal,
     render_instant_card,
     ...props_on_class
   }: ConstructorOptions<InputDisplay, OutputDisplay>);
+  get enable_content_search(): boolean | undefined;
+  set enable_content_search(new_state: boolean | undefined);
   get on_navigation(): OnNavigation;
   set on_navigation(new_function: OnNavigation);
   get localization(): search_i18n;
@@ -708,11 +745,50 @@ export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformed
    */
   uniqueInstanceKeyForState?: string;
 } & (InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
+  /**
+   * @deprecated use displayTransformers instead
+   */
   pageURLCreator?: PageURLCreator<InputDisplay, PossibleTransformedDisplay>;
+  /**
+   * Functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+   */
+  displayTransformers?: never;
+} | {
+  /**
+   * @deprecated use displayTransformers instead
+   */
+  pageURLCreator?: never;
+  /**
+   * Functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+   */
+  displayTransformers: DisplayTransformers<InputDisplay, PossibleTransformedDisplay>;
 } : {
+  /**
+   * @deprecated use displayTransformers instead
+   */
   pageURLCreator: PageURLCreator<InputDisplay, PossibleTransformedDisplay>;
+  /**
+   * Functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+   */
+  displayTransformers?: never;
+} | {
+  /**
+   * Functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+   */
+  displayTransformers: DisplayTransformers<InputDisplay, PossibleTransformedDisplay>;
+  /**
+   * @deprecated use displayTransformers instead
+   */
+  pageURLCreator?: never;
 } : {
+  /**
+   * @deprecated use displayTransformers instead
+   */
   pageURLCreator?: never;
+  /**
+   * Functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way.
+   */
+  displayTransformers?: never;
 });
 export type BaseSearchProviderConfig = {
   /**
@@ -731,6 +807,11 @@ export type BaseSearchProviderConfig = {
    * @default false
    */
   enableCategorySuggestions?: boolean;
+  /**
+   * Whether to enable content search in the search modal and search page.
+   * @default false
+   */
+  enableContentSearch?: boolean;
 };
 export interface BaseProductListingConfig {
   /**