@depict-ai/ui 2.0.21 → 2.0.23

package/server/ES10/index.d.ts

@@ -1,5 +1,5 @@
 import { JSX, Accessor, Signal, Setter } from "solid-js";
-import { Amazing_Slider, Display, ColsAtSize, report, Elem, ModernDisplay, Node_Array } from "@depict-ai/utilishared/ES10";
+import { Display, Amazing_Slider, 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,46 @@ 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 = "2.0.21";
+export const version = "2.0.23";
+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;
+  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.
+ */
+export type ListingType = "collection" | "category";
+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>;
+/**
+ * Function that encodes a filter object into query parameters and sets them on the given URLSearchParams object.
+ */
+export function encode_filters(filters: FilterWithData[], search_params: URLSearchParams, filter_query_param_prefix: string): void;
+/**
+ * Function that decodes the filters from the provided query parameters and returns them as an array of filter objects.
+ */
+export function decode_filters(search_params: URLSearchParams, filter_query_param_prefix: string): FilterWithData[];
 /**
  * Provider to wrap every listing (group of products) in
  * Used for example for deduplicating ResizeObservers for responsive images
@@ -84,37 +123,6 @@ export function SlidableItems({
  * Returns accessor with the size of the provided element, including padding and border (I think)
  */
 export function make_accurate_size_accessor(what_to_watch: HTMLElement): import("solid-js").Accessor<number | undefined>;
-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;
-  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.
- */
-export type ListingType = "collection" | "category";
-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
@@ -342,10 +350,6 @@ export function SelectedFilters({
   selected_filters_: Signal<FilterWithData[]>;
   local_filter_cache_: Signal<SearchFilter[]>;
 }): HTMLDivElement;
-/**
- * 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>;
 /**
  * Base placeholder component used by ImagePlaceholder and TextPlaceholder
  */
@@ -614,6 +618,10 @@ export class DepictAPI<InputDisplay extends Display, OutputDisplay extends Moder
     failed?: true | undefined;
   }>;
 }
+/**
+ * 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>;
 /**
  * Disables scrolling until the solidjs reactive scoped is disposed (onCleanup)
  * @returns A cleanup function to manually re-enable scrolling.