@depict-ai/ui 3.0.3 → 3.0.5

package/server/latest/index.d.ts

@@ -1,16 +1,193 @@
+import { ColsAtSize, Display, ModernDisplay, Amazing_Slider, Node_Array, report, Elem } from "@depict-ai/utilishared/latest";
 import { JSX, Signal, Accessor, Setter } from "solid-js";
-import { Amazing_Slider, Node_Array, Display, report, ColsAtSize, Elem, ModernDisplay } from "@depict-ai/utilishared/latest";
 import { SearchFilter, SortModel, SearchRequestV3 } from "@depict-ai/types/api/SearchRequestV3";
-import { SearchFilter as _SearchFilter1, ContentLink, SearchResponse } from "@depict-ai/types/api/SearchResponse";
-import { CategorySuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
-import { Breadcrumb, Quicklink, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
+import { ContentLink, SearchFilter as _SearchFilter1, SearchResponse } from "@depict-ai/types/api/SearchResponse";
+import { ListingSuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
+import { ProductListing, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
 import { ProductListingResponseV3 } from "@depict-ai/types/api/ProductListingResponseV3";
 import { SearchSuggestionsRequestV3 } from "@depict-ai/types/api/SearchSuggestionsRequestV3";
 import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequestV3";
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
 import { SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "3.0.3";
+export const version = "3.0.5";
+export type SDKColsAtSize = [number, number?][];
+/**
+ * Transform SDK ColsAtSize into valid Layout ColsAtSize
+ * @param cols_at_size [nbCol, maxWidth]
+ * @returns
+ */
+export const convert_sdk_cols_at_size_to_layout: (cols_at_size: SDKColsAtSize) => ColsAtSize;
+declare const LISTING_ID = "listingId";
+declare const EXTERNAL_ID = "externalId";
+export type SDKGridSpacing = string | {
+  horizontal: string;
+  vertical: string;
+};
+export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
+type FilterWithData = WithRequired<SearchFilter, "data">;
+export interface SDKRenderingInfo {
+  /**
+   * If you call this function with a provided function, the provided function will be called whenever the index of the currently displayed product changes.
+   */
+  set_on_index_change: (fn: (index: number) => void) => void;
+}
+export type ProductCardTemplate<T extends Display> = (display: T | null, info?: SDKRenderingInfo) => JSX.Element | Promise<JSX.Element>;
+type AddActualFieldToArray<T> = T extends Array<infer U> ? (U & {
+  actual_field?: string;
+})[] : never;
+type AddActualFieldToFilters<T extends SearchFilter[] | undefined> = T extends undefined ? undefined : AddActualFieldToArray<T>;
+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?: <T extends ProductListing | ListingSuggestion>(options: DisplayTransformerAlwaysThereData & {
+    data: T[];
+  }) => CanBePromiseWrapped<(T & {
+    page_url: string;
+  })[]>;
+  contentResults?: (options: DisplayTransformerAlwaysThereData & {
+    data: ContentLink[];
+  }) => CanBePromiseWrapped<ContentLink[]>;
+};
+export type SomethingTakingADisplayTransformers<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
+  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
+} : {
+  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
+} : {
+  page_url_creator?: never;
+  display_transformers?: never;
+};
+export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformedDisplay extends ModernDisplay | never> = {
+  /**
+   * The merchant to use for the search.
+   * @example "YOUR_MERCHANT", "stronger"
+   */
+  merchant: string;
+  /**
+   * The market to use for the search.
+   * @example "YOUR_MARKET", "no", "en-de"
+   */
+  market: string;
+  /**
+   * Optional unique identifer of the user. Only necessary when performing server side requests to Depict. All Depict tooling has a fallback ID that will be used when this isn't specified, but if you make requests to Depict directly, you need to specify this everywhere.
+   */
+  sessionId?: string;
+  /**
+   * 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.
+   * This is because there's state in the URL and history.state and the state of the different instances would collide.
+   * By setting this property, you can specify a unique key for each instance, so that the state of each instance is kept separate.
+   * We recommend to just use an incrementing number for this, e.g. "1", "2", "3", ...
+   */
+  uniqueInstanceKeyForState?: string;
+} & (InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
+  /**
+   * 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>;
+} : {
+  /**
+   * 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>;
+} : {
+  /**
+   * 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 = {
+  /**
+   * The path to the search page.
+   * @example "/search", "/sok"
+   */
+  searchPagePath: string;
+  /**
+   * The name of the url parameter that will be used for the search query.
+   * @example "q", "search_query", "query"
+   * @default "query"
+   */
+  urlParamName?: string;
+  /**
+   * Whether to enable category suggestions in the search modal and search page.
+   * @default false
+   */
+  enableCategorySuggestions?: boolean;
+  /**
+   * Whether to enable content search in the search modal and search page.
+   * @default false
+   */
+  enableContentSearch?: boolean;
+};
+export type BaseCategoryProviderConfig = {
+  /**
+   * The parameter `listing_id=` will override the regular category id that you have configured your SDK to use. You can consider the `listing_id` as an escape-hatch if you want to easily set a listing id.
+   * However, if your page already sets a listing_id, you can disable this behaviour by setting this property to `true` (to avoid a conflict).
+   */
+  disableOverrideListingId?: boolean;
+};
+export interface BaseProductListingConfig {
+  /**
+   * How many columns to show at each media size.
+   * @default
+   * [[2, 901], [3, 1024], [4]]
+   * @example
+   * [[2, 901], [3, 1024], [4]]
+   * means 2 columns at sizes up to 901px, 3 columns at sizes up to 1024px and after that 4 columns at any viewport size.
+   */
+  columnsAtSize?: SDKColsAtSize;
+  /**
+   * The spacing between products.
+   * @default "2%"
+   * @example
+   * "2%", "10px", "1rem", {horizontal: "1%", vertical: "5px"}
+   */
+  gridSpacing?: SDKGridSpacing;
+}
+export interface BaseSearchPageConfig extends BaseProductListingConfig {
+  /**
+   * Whether to show the search input field in the search page.
+   * @default true
+   */
+  includeInputField?: boolean;
+}
+export interface BaseCategoryPageConfig extends BaseProductListingConfig {
+  /**
+   * Whether to show the breadcrumbs in the category page.
+   * @default true
+   */
+  showBreadcrumbs?: boolean;
+  /**
+   * Whether to show the quicklinks in the category page.
+   * @default true
+   */
+  showQuicklinks?: boolean;
+}
+/**
+ * The listing to query Depict for. `type` can be `"listingId"` or `"externalId"` and `id` is the actual id.
+ * If `id` is `"listingId"`, it should be a uuid where Depict is the source of truth, you can get them here: https://api.depict.ai/docs#tag/Listing/operation/Get_Listings_v3_listings_get.
+ * If `id` is `"externalId"`, it should be the id of the product listing in your system - whatever was passed to Depict during data ingestion.
+ */
+export type ListingQuery = {
+  type: typeof LISTING_ID | typeof EXTERNAL_ID;
+  id: string;
+};
 /** @jsxImportSource solid-js */
 export function GenericSliderArrowButton(props?: {
   width_?: number;
@@ -97,7 +274,7 @@ declare class PseudoRouter {
   /**
    * We store listing_id in history.state and do operate on this both here and in js-ui, this is the key to be used which js-ui provides
    */
-  listing_id_state_key: string | undefined;
+  listing_query_state_key: string | undefined;
   navigate_: {
     /**
      * Call this if you *just* want to replace the state object in history.state
@@ -118,11 +295,11 @@ declare class PseudoRouter {
       event_?: MouseEvent | undefined;
       force_spa_navigation_?: boolean | undefined;
       is_replace_: boolean;
-      listing_id_?: string | undefined;
+      listing_query_?: ListingQuery | undefined;
       scroll?: boolean | undefined;
     }) => Promise<void | undefined>;
   };
-  constructor(on_navigation: OnNavigation, listing_id_state_key?: string);
+  constructor(on_navigation: OnNavigation, listing_query_state_key?: string);
 }
 /**
  * Makes signals out of values in history.state so that you can use history state as an intuitive storage of application state.
@@ -131,23 +308,6 @@ declare class PseudoRouter {
  * @returns An object with the same keys as provided with the value being a Signal containing the default value. When the signal is set, history.replaceState is called and the key/value is put into history.state. If something else pushes a new state or the state is poped the signal value will update to always be in-line with the value of history.state.
  */
 export function history_dot_state_to_state<Param extends string, DefaultValue>(params_to_default_value: Record<Param, DefaultValue>, router_: PseudoRouter): Record<Param, Signal<any>>;
-export type SDKGridSpacing = string | {
-  horizontal: string;
-  vertical: string;
-};
-export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
-type FilterWithData = WithRequired<SearchFilter, "data">;
-export interface SDKRenderingInfo {
-  /**
-   * If you call this function with a provided function, the provided function will be called whenever the index of the currently displayed product changes.
-   */
-  set_on_index_change: (fn: (index: number) => void) => void;
-}
-export type ProductCardTemplate<T extends Display> = (display: T | null, info?: SDKRenderingInfo) => JSX.Element | Promise<JSX.Element>;
-type AddActualFieldToArray<T> = T extends Array<infer U> ? (U & {
-  actual_field?: string;
-})[] : never;
-type AddActualFieldToFilters<T extends SearchFilter[] | undefined> = T extends undefined ? undefined : AddActualFieldToArray<T>;
 /**
  * Disables scrolling until the solidjs reactive scoped is disposed (onCleanup)
  * @returns A cleanup function to manually re-enable scrolling.
@@ -193,13 +353,6 @@ type ImagePlaceholderImageOptions = {
  * @property style extra styles to add to the placeholder
  */
 export function ImagePlaceholder(props: ImagePlaceholderBaseOptions & (ImagePlaceholderBlockOptions | ImagePlaceholderImageOptions)): JSX.Element;
-export type SDKColsAtSize = [number, number?][];
-/**
- * Transform SDK ColsAtSize into valid Layout ColsAtSize
- * @param cols_at_size [nbCol, maxWidth]
- * @returns
- */
-export const convert_sdk_cols_at_size_to_layout: (cols_at_size: SDKColsAtSize) => ColsAtSize;
 /**
  * A Placeholder to use instead of some text, while it's loading. This is the inline version, meant to be embedded into sentences (or exist instead of them), etc.
  * If you want a block version, use `ImagePlaceholder` with `width`and `height` set instead.
@@ -586,39 +739,6 @@ export function create_modified_filters({
   }[]>;
   local_filter_cache_: Signal<_SearchFilter1[]>;
 }): void;
-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?: <T extends Breadcrumb | Quicklink | CategorySuggestion>(options: DisplayTransformerAlwaysThereData & {
-    data: T[];
-  }) => CanBePromiseWrapped<(T & {
-    page_url: string;
-  })[]>;
-  contentResults?: (options: DisplayTransformerAlwaysThereData & {
-    data: ContentLink[];
-  }) => CanBePromiseWrapped<ContentLink[]>;
-};
-export type SomethingTakingADisplayTransformers<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
-  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
-} : {
-  display_transformers: DisplayTransformers<InputDisplay, OutputDisplay>;
-} : {
-  page_url_creator?: never;
-  display_transformers?: never;
-};
 export type ExclusiveId = {
   categoryId: string;
   productId?: undefined;
@@ -689,33 +809,33 @@ export type InstantCard<T extends Display> = (display: T, context: {
   merchant: string;
   market: string;
 }) => JSX.Element;
-type CategorySuggestionAfterURLCreator = CategorySuggestion & {
+type CategorySuggestionAfterURLCreator = ListingSuggestion & {
   page_url: string;
 };
-type ReplaceCategorySuggestion<T> = T extends CategorySuggestion ? CategorySuggestionAfterURLCreator : T extends CategorySuggestion[] ? CategorySuggestionAfterURLCreator[] : T;
+type ReplaceCategorySuggestion<T> = T extends ListingSuggestion ? CategorySuggestionAfterURLCreator : T extends ListingSuggestion[] ? CategorySuggestionAfterURLCreator[] : T;
 type SearchSuggestionsResponseAfterURLCreator = { [K in keyof SearchSuggestionsResponseV3]: ReplaceCategorySuggestion<SearchSuggestionsResponseV3[K]> };
 type AddPageUrlToDisplay<T extends any[]> = (T[number] & {
   page_url: string;
 })[];
 type SearchResponseAfterDisplayTransformer = { [K in keyof SearchResponse]: K extends "displays" ? AddPageUrlToDisplay<SearchResponse[K]> : K extends "filters" ? AddActualFieldToFilters<SearchResponse[K]> : SearchResponse[K] };
-type QuicklinksOrBreadCrumbsWithPageURL<T extends Breadcrumb | Quicklink> = T & {
+type ProductListingWithPageURL = ProductListing & {
   page_url: string;
 };
 type _AddPageUrlToDisplay1<T extends any[]> = (T[number] & {
   page_url: string;
 })[];
 type ProductListingResponseAfterDisplayTransformer = { [K in keyof ProductListingResponseV3]: K extends "displays" ? _AddPageUrlToDisplay1<ProductListingResponseV3[K]> : K extends "filters" ? AddActualFieldToFilters<ProductListingResponseV3[K]> : ProductListingResponseV3[K] };
-type GetListingResponseAfterDisplayTransformer = { [K in keyof GetListingResponse]: K extends "breadcrumbs" ? QuicklinksOrBreadCrumbsWithPageURL<Breadcrumb>[] : K extends "quick_links" ? QuicklinksOrBreadCrumbsWithPageURL<Quicklink>[] : GetListingResponse[K] };
+type GetListingResponseAfterDisplayTransformer = { [K in keyof GetListingResponse]: K extends "breadcrumbs" ? ProductListingWithPageURL[] : K extends "quick_links" ? ProductListingWithPageURL[] : GetListingResponse[K] };
 type DepictAPIConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = {
   get_metadata?: () => Promise<{
     [k: string]: string;
   } | undefined>;
   get_session_id?: () => string | undefined;
 } & SomethingTakingADisplayTransformers<InputDisplay, OutputDisplay>;
-interface GetListingOptions extends GetListingRequest {
-  listing_id: string;
+interface GetListingOptions extends Omit<GetListingRequest, "listing_id"> {
   session_id?: string;
-  market: string;
+  id_to_query_for_: string;
+  id_type_: typeof LISTING_ID | typeof EXTERNAL_ID;
 }
 /**
  * Class that handles all communication done in PLP code with the Depict API. (Notably not for recommendations currently).
@@ -731,11 +851,20 @@ export class DepictAPI<InputDisplay extends Display, OutputDisplay extends Moder
   query(input_req: SearchRequestV3): Promise<SearchResponseAfterDisplayTransformer & {
     failed?: true;
   }>;
-  get_listing(input_req: GetListingOptions): Promise<GetListingResponseAfterDisplayTransformer & {
+  get_listing({
+    id_type_,
+    id_to_query_for_,
+    ...input_req
+  }: GetListingOptions): Promise<GetListingResponseAfterDisplayTransformer & {
     failed?: true;
   }>;
-  get_listing_products(input_req: ProductListingRequestV3 & {
-    listing_id: string;
+  get_listing_products({
+    id_to_query_for_,
+    id_type_,
+    ...input_req_
+  }: ProductListingRequestV3 & {
+    id_to_query_for_: string;
+    id_type_: typeof LISTING_ID | typeof EXTERNAL_ID;
   }): Promise<ProductListingResponseAfterDisplayTransformer & {
     failed?: true;
   }>;
@@ -778,7 +907,7 @@ type GeneralCategoryListingOptions = {
   localization: category_i18n;
   unique_instance_key_for_state?: string;
   on_navigation?: OnNavigation;
-  listing_id_state_key?: string;
+  listing_query_state_key?: string;
 };
 type CategoryConstructorOptionsWithApi<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never> = GeneralCategoryListingOptions & {
   api: DepictAPI<InputDisplay, OutputDisplay>;
@@ -794,14 +923,12 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
   #private;
   get localization(): category_i18n;
   set localization(locale_obj: category_i18n);
-  get listing_id(): string;
-  set listing_id(id: string);
+  get listing_query(): ListingQuery;
+  set listing_query(query: ListingQuery);
   get merchant(): string;
   set merchant(merchant: string);
   get market(): string;
   set market(market: string);
-  get meta_title_suffix(): string | undefined;
-  set meta_title_suffix(new_suffix: string | undefined);
   get disable_override_listing_id(): boolean | undefined;
   set disable_override_listing_id(new_value: boolean | undefined);
   get on_navigation(): OnNavigation;
@@ -811,7 +938,7 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
     on_navigation,
     display_transformers,
     unique_instance_key_for_state,
-    listing_id_state_key,
+    listing_query_state_key,
     ...props_on_class
   }: DepictCategoryConstructorOptions<InputDisplay, OutputDisplay>);
 }
@@ -828,9 +955,9 @@ export function CategoryPage<OriginalDisplay extends Display, OutputDisplay exte
   show_quicklinks?: boolean;
   show_breadcrumbs?: boolean;
   category_title: typeof CategoryTitle | typeof embedded_num_products;
-  on_listing_id_change?: (new_listing_id?: string | undefined, old_listing_id?: string | undefined) => void;
+  on_listing_query_change?: (new_listing_query?: ListingQuery | undefined, old_listing_query?: ListingQuery | undefined) => void;
   content_blocks_by_row?: ContentBlocksByRow;
-}): import("@depict-ai/utilishared").Node_Array;
+}): import("@depict-ai/utilishared/latest").Node_Array;
 export function BreadCrumbs<T extends Display>({
   depict_category
 }: {
@@ -844,7 +971,7 @@ export function QuickLinks<T extends Display>({
 /**
  * Gets available listings for a given merchant, market and locale
  */
-export function get_listings(merchant: string, market: string, locale: string): Promise<import("@depict-ai/types/api/ListingResponseItem").ListingResponseItem1[]>;
+export function get_listings(merchant: string, market: string, locale: string): Promise<import("@depict-ai/types/api/ListListingsResponseItem").ListListingsResponseItem1[]>;
 export function DefaultInstantCardPlaceholder(): HTMLDivElement;
 /**
  * Useful for aligning the search modal to an element, like an existing input field
@@ -960,123 +1087,6 @@ interface SearchFieldParams {
   aligner_ref?: HTMLElement | null;
 }
 export function SearchField(props: SearchFieldParams): HTMLDivElement[];
-export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformedDisplay extends ModernDisplay | never> = {
-  /**
-   * The merchant to use for the search.
-   * @example "YOUR_MERCHANT", "stronger"
-   */
-  merchant: string;
-  /**
-   * The market to use for the search.
-   * @example "YOUR_MARKET", "no", "en-de"
-   */
-  market: string;
-  /**
-   * Optional unique identifer of the user. Only necessary when performing server side requests to Depict. All Depict tooling has a fallback ID that will be used when this isn't specified, but if you make requests to Depict directly, you need to specify this everywhere.
-   */
-  sessionId?: string;
-  /**
-   * 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.
-   * This is because there's state in the URL and history.state and the state of the different instances would collide.
-   * By setting this property, you can specify a unique key for each instance, so that the state of each instance is kept separate.
-   * We recommend to just use an incrementing number for this, e.g. "1", "2", "3", ...
-   */
-  uniqueInstanceKeyForState?: string;
-} & (InputDisplay extends ModernDisplay ? "page_url" extends keyof InputDisplay["variant_displays"][number] ? {
-  /**
-   * 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>;
-} : {
-  /**
-   * 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>;
-} : {
-  /**
-   * 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 = {
-  /**
-   * The path to the search page.
-   * @example "/search", "/sok"
-   */
-  searchPagePath: string;
-  /**
-   * The name of the url parameter that will be used for the search query.
-   * @example "q", "search_query", "query"
-   * @default "query"
-   */
-  urlParamName?: string;
-  /**
-   * Whether to enable category suggestions in the search modal and search page.
-   * @default false
-   */
-  enableCategorySuggestions?: boolean;
-  /**
-   * Whether to enable content search in the search modal and search page.
-   * @default false
-   */
-  enableContentSearch?: boolean;
-};
-export type BaseCategoryProviderConfig = {
-  /**
-   * Currently used for SEO long tail only.
-   * Read more about SEO collections here https://docs.depict.ai/other-guides/seo-collections-guide/introduction
-   * @default ""
-   * @example
-   * If the generated SEO title is "Blue Jeans", and you specify metaTitleSuffix to " | My Store", the final SEO title will be "Blue Jeans | My Store".
-   */
-  metaTitleSuffix?: string;
-  /**
-   * The parameter `listing_id=` will override the regular category id that you have configured your SDK to use. You can consider the `listing_id` as an escape-hatch if you want to easily set a listing id.
-   * However, if your page already sets a listing_id, you can disable this behaviour by setting this property to `true` (to avoid a conflict).
-   */
-  disableOverrideListingId?: boolean;
-};
-export interface BaseProductListingConfig {
-  /**
-   * How many columns to show at each media size.
-   * @default
-   * [[2, 901], [3, 1024], [4]]
-   * @example
-   * [[2, 901], [3, 1024], [4]]
-   * means 2 columns at sizes up to 901px, 3 columns at sizes up to 1024px and after that 4 columns at any viewport size.
-   */
-  columnsAtSize?: SDKColsAtSize;
-  /**
-   * The spacing between products.
-   * @default "2%"
-   * @example
-   * "2%", "10px", "1rem", {horizontal: "1%", vertical: "5px"}
-   */
-  gridSpacing?: SDKGridSpacing;
-}
-export interface BaseSearchPageConfig extends BaseProductListingConfig {
-  /**
-   * Whether to show the search input field in the search page.
-   * @default true
-   */
-  includeInputField?: boolean;
-}
-export interface BaseCategoryPageConfig extends BaseProductListingConfig {
-  /**
-   * Whether to show the breadcrumbs in the category page.
-   * @default true
-   */
-  showBreadcrumbs?: boolean;
-  /**
-   * Whether to show the quicklinks in the category page.
-   * @default true
-   */
-  showQuicklinks?: boolean;
-}
 type CenteredLocation = {
   location?: "centered";
 };