@depict-ai/ui 1.4.25 → 2.0.0

package/ES10/index.d.ts

@@ -1,5 +1,5 @@
 import { JSX, Signal, Accessor, Setter } from "solid-js";
-import { Display, report, ColsAtSize, Elem, ModernDisplay, Node_Array } from "@depict-ai/utilishared/ES10";
+import { Display, ColsAtSize, report, Elem, ModernDisplay, Node_Array } from "@depict-ai/utilishared/ES10";
 import { SearchFilter, SearchRequest } from "@depict-ai/types/api/SearchRequest";
 import { SearchFilter as _SearchFilter1, ContentLink, SearchResponse } from "@depict-ai/types/api/SearchResponse";
 import { BaseCategoryDisplay, ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
@@ -7,7 +7,7 @@ import { CategorySuggestion, SearchSuggestionsResponse } from "@depict-ai/types/
 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.25";
+export const version = "2.0.0";
 export type SDKGridSpacing = string | {
   horizontal: string;
   vertical: string;
@@ -15,11 +15,21 @@ export type SDKGridSpacing = 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;
   merchant: string;
   market: string;
 }
 export type ProductCardTemplate<T extends Display> = (display: T | null, info?: SDKRenderingInfo) => JSX.Element | Promise<JSX.Element>;
+type WithoutMerchant<T> = T extends {
+  merchant: string;
+} ? Omit<T, "merchant"> : T;
+type WithoutMarket<T> = T extends {
+  market: string;
+} ? Omit<T, "market"> : T;
+export type ProductCardTemplateWithoutMerchantAndMarket<T extends Display> = (display: Parameters<ProductCardTemplate<T>>[0], info?: WithoutMerchant<WithoutMarket<SDKRenderingInfo>>) => ReturnType<ProductCardTemplate<T>>;
 /**
  * Will be sent to backend to indicate whether the query_id_ is for a collection or category.
  * Backend defaults to category if not specified.
@@ -29,6 +39,13 @@ 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>;
+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 class SDKError extends Error {}
 export class ProductCardError extends SDKError {
   constructor(templateError: Error);
@@ -55,7 +72,7 @@ export type SolidLayoutOptions = {
   disable_partial_rows?: boolean;
   override_vertical_spacing?: string;
   children: JSX.Element;
-  element_attributes: JSX.HTMLAttributes<HTMLDivElement>;
+  element_attributes: Omit<JSX.HTMLAttributes<HTMLDivElement>, "classList">;
 };
 /**
  * SolidLayout: SolidJS adaption of Layout. Calculates CSS for a grid or slider with a certain spacing and certain number of columns at certain screen sizes, including a view more button. All properties are reactive.
@@ -67,25 +84,11 @@ export type SolidLayoutOptions = {
  * @return An accessor containing a CSS string
  */
 export function SolidLayout(props: SolidLayoutOptions): 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;
 /** @jsxImportSource solid-js */
 export function GenericSliderArrowButton(props?: {
   width_?: number;
   height_?: number;
 }): SVGElement;
-type WithoutMerchant<T> = T extends {
-  merchant: string;
-} ? Omit<T, "merchant"> : T;
-type WithoutMarket<T> = T extends {
-  market: string;
-} ? Omit<T, "market"> : T;
-type ModifiedProductCardTemplate<T extends Display> = (display: Parameters<ProductCardTemplate<T>>[0], info?: WithoutMerchant<WithoutMarket<SDKRenderingInfo>>) => ReturnType<ProductCardTemplate<T>>;
 type RecommendationSliderBaseProps<T extends Display> = {
   grid_spacing: SDKGridSpacing;
   cols_at_size: SDKColsAtSize;
@@ -99,19 +102,12 @@ export function RecommendationSlider<T extends Display>(props: {
   product_card_template: ProductCardTemplate<T>;
   merchant: string;
   market: string;
-} & RecommendationSliderBaseProps<T>): any;
+} & RecommendationSliderBaseProps<T>): HTMLDivElement;
 export function RecommendationSlider<T extends Display>(props: {
-  product_card_template: ModifiedProductCardTemplate<T>;
+  product_card_template: ProductCardTemplateWithoutMerchantAndMarket<T>;
   merchant?: never;
   market?: never;
-} & RecommendationSliderBaseProps<T>): any;
-type _WithoutMerchant1<T> = T extends {
-  merchant: string;
-} ? Omit<T, "merchant"> : T;
-type _WithoutMarket1<T> = T extends {
-  market: string;
-} ? Omit<T, "market"> : T;
-type _ModifiedProductCardTemplate1<T extends Display> = (display: Parameters<ProductCardTemplate<T>>[0], info?: _WithoutMerchant1<_WithoutMarket1<SDKRenderingInfo>>) => ReturnType<ProductCardTemplate<T>>;
+} & RecommendationSliderBaseProps<T>): HTMLDivElement;
 type RecommendationGridBaseProps<T extends Display> = {
   grid_spacing: SDKGridSpacing;
   cols_at_size: SDKColsAtSize;
@@ -130,12 +126,12 @@ export function RecommendationGrid<T extends Display>(props: {
   product_card_template: ProductCardTemplate<T>;
   merchant: string;
   market: string;
-} & RecommendationGridBaseProps<T>): any;
+} & RecommendationGridBaseProps<T>): HTMLDivElement;
 export function RecommendationGrid<T extends Display>(props: {
-  product_card_template: _ModifiedProductCardTemplate1<T>;
+  product_card_template: ProductCardTemplateWithoutMerchantAndMarket<T>;
   merchant?: never;
   market?: never;
-} & RecommendationGridBaseProps<T>): any;
+} & RecommendationGridBaseProps<T>): HTMLDivElement;
 /**
  * Returns an accessor that will update when the size of the provided element changes, to be used with ResponsiveImg
  */
@@ -824,7 +820,7 @@ interface SearchFieldParams {
   click_handler?: (this: HTMLDivElement, ev: MouseEvent) => any;
   aligner_ref?: HTMLElement | null;
 }
-export function SearchField(props: SearchFieldParams): import("@depict-ai/utilishared").Node_Array;
+export function SearchField(props: SearchFieldParams): HTMLDivElement[];
 export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformedDisplay extends ModernDisplay | never> = {
   /**
    * The merchant to use for the search.