@depict-ai/ui 0.0.83 → 1.0.1

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { SearchSuggestionsResponse, CategorySuggestion } from "@depict-ai/types/
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
 import { ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
-export const version = "0.0.83";
+export const version = "1.0.1";
 export type OnNavigation = ((options: {
     is_replace: boolean;
     new_url: URL;
@@ -33,6 +33,8 @@ type RecsAPIWrapperOptions = {
     type: string;
     merchant: string;
     market: string;
+    userId?: string;
+    sessionId?: string;
     headers?: HeadersInit;
 } & ExclusiveId;
 /**
@@ -45,6 +47,8 @@ type RecsAPIWrapperOptions = {
  * @param categoryId When requesting recommendations for a category page, pass the id of the category page as `categoryId`.
  * @param productId When requesting recommendations for a single product, e.g. on a product detail page, pass the id of the product as `productId`.
  * @param productIds When requesting recommendations that should take multiple products into account, i.e. the contents of the basket/cart, pass an array of product ids as `productIds`
+ * @param userId Optional unique identifier of a logged in user. Should be persistent across devices and sessions.
+ * @param sessionId Optional unique identifer of the current session. Only necessary when performing server side requests to Depict.
  * @param headers Optional headers to send to the Depict API. This could be authentication for example. 99% of integrations can leave this unset.
  * When no id is provided (none out of `categoryId`, `productId` and `productIds`) general recommendations will be fetched. This is for, for example, the frontpage where generally popular products get returned.
  *
@@ -158,11 +162,16 @@ export type InstantCard<T extends Display> = (display: T, context: {
     merchant: string;
     market: string;
 }) => JSX.Element;
+interface DepictAPIConstructorOptions {
+    get_metadata?: () => Promise<{
+        [k: string]: string;
+    } | undefined>;
+    get_user_id?: () => string | undefined;
+    get_session_id?: () => string | undefined;
+}
 export class DepictAPI {
     #private;
-    constructor(get_metadata?: () => Promise<{
-        [k: string]: string;
-    } | undefined>);
+    constructor({ get_metadata, get_user_id, get_session_id }?: DepictAPIConstructorOptions);
     suggest(input_req: SearchSuggestionsRequest): Promise<SearchSuggestionsResponse & {
         failed?: true;
     }>;
@@ -374,6 +383,18 @@ export type BaseProviderConfig = {
      * @example "YOUR_MARKET", "no", "en-de"
      */
     market: string;
+    /**
+     * Optional unique identifier of a logged in user. Should be persistent across devices and sessions.
+     */
+    userId?: string;
+    /**
+     * Optional unique identifer of the current session. Only necessary when performing server side requests to Depict.
+     */
+    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>;
 };
 export type BaseSearchProviderConfig = {
     /**

package/dist/main.js

@@ -35,7 +35,7 @@ $parcel$export(module.exports, "SolidFormatPrice", () => $5fc9fc23df1591db$expor
 $parcel$export(module.exports, "connect_search_field_height_to_aligner_height", () => $246e3e89a097f014$export$828dcdd425fd3231);
 $parcel$export(module.exports, "PageReplacer", () => $37e96a5ebc768cc7$export$3ccaa27d81dd8556);
 $parcel$export(module.exports, "version", () => $ae93561d5649a847$export$83d89fbfd8236492);
-/*! Depict.ai search and product listing SDK */ const $ae93561d5649a847$export$83d89fbfd8236492 = "0.0.83";
+/*! Depict.ai search and product listing SDK */ const $ae93561d5649a847$export$83d89fbfd8236492 = "1.0.1";
 
 
 
@@ -114,15 +114,6 @@ function $0de081f67b6d15b5$export$9862539c89138352(get_default_values_, router_)
 
 const $9ce64f69303c371e$var$v2_base_url = (0, $46MJV$depictaiutilishared.base_url) + "/v2/";
 const $9ce64f69303c371e$var$search_base_url = $9ce64f69303c371e$var$v2_base_url + "search/";
-const $9ce64f69303c371e$var$add_ids_to_request = (input_req)=>{
-    const request = {
-        ...input_req
-    };
-    request.dsid ??= (0, $46MJV$depictaiutilishared.get_depict_id)();
-    request.user_id ??= (0, $46MJV$depictaiutilishared.get_user_id)();
-    request.session_id ??= (0, $46MJV$depictaiutilishared.get_session_id)();
-    return request;
-};
 class $9ce64f69303c371e$export$e015ed2f2950f2e3 {
     #supports_finalization_registry = typeof FinalizationRegistry === "function";
     #cache_objs = {};
@@ -137,12 +128,26 @@ class $9ce64f69303c371e$export$e015ed2f2950f2e3 {
             })) : undefined
         };
     }
+    #add_ids_to_request = (input_req)=>{
+        const request = {
+            ...input_req
+        };
+        request.dsid ??= (0, $46MJV$depictaiutilishared.get_depict_id)();
+        // Todo: remove the default user and session IDs once we've confirmed backend can handle it and do whatever fallback is necessary.
+        request.user_id ??= this.#get_user_id?.() || (0, $46MJV$depictaiutilishared.get_user_id)();
+        request.session_id ??= this.#get_session_id?.() || (0, $46MJV$depictaiutilishared.get_session_id)();
+        return request;
+    };
     #get_metadata;
-    constructor(get_metadata){
+    #get_user_id;
+    #get_session_id;
+    constructor({ get_metadata: get_metadata , get_user_id: get_user_id , get_session_id: get_session_id  } = {}){
         this.#get_metadata = get_metadata;
+        this.#get_user_id = get_user_id;
+        this.#get_session_id = get_session_id;
     }
     async suggest(input_req) {
-        const request = $9ce64f69303c371e$var$add_ids_to_request(input_req);
+        const request = this.#add_ids_to_request(input_req);
         const url = (0, $46MJV$depictaiutilishared.make_url_with_query_params)($9ce64f69303c371e$var$search_base_url + "suggestions", request);
         const results = await (0, $46MJV$depictaiutilishared.fetch_retry)((0, $46MJV$depictaiutilishared.add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -159,7 +164,7 @@ class $9ce64f69303c371e$export$e015ed2f2950f2e3 {
     }
     async #cached_post_request(endpoint1, input_req, fallback_response) {
         const cache_obj = this.#get_cache_obj_for_endpoint(endpoint1);
-        const with_ids = $9ce64f69303c371e$var$add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
         const metaData = await this.#get_metadata?.();
         const request = metaData ? Object.assign(with_ids, {
             metadata: metaData
@@ -833,7 +838,8 @@ function $7b0b7e887b485a91$export$f33414a4df0afd3f({ product_card_template_: pro
         if (!unwrapped_array?.length || !unwrapped_array.every((item)=>item)) // Haven't finished rendering yet in case of "async" rendering, so don't freeze the elements yet
         return;
         // placeholders have finished rendering, freeze the elements
-        $7b0b7e887b485a91$var$cached_placeholder_element = get_cloned_placeholders(unwrapped_array); // Clone initial return value so that who gave us the elements can't mutate them, which has caused issues before with react
+        // here we might receive the result of a promise that has already been received, tore down and put into cached_placeholder_element, so don't overwrite that more valid result if it's already set
+        $7b0b7e887b485a91$var$cached_placeholder_element ||= get_cloned_placeholders(unwrapped_array); // Clone initial return value so that who gave us the elements can't mutate them, which has caused issues before with react
         $7b0b7e887b485a91$var$rendering_cached_placeholder_element = undefined;
         dispose_original_copy(); // So that this memo will never re-run and the placeholder rendering function can clean up
         return get_cloned_placeholders(); // clone, just in case. If we wouldn't, someone could modify the copy in the DOM, and it would affect the cached version

package/dist/module.js

@@ -1,9 +1,9 @@
-import {add_to_version_info as $g9l4l$add_to_version_info, fetch_recs as $g9l4l$fetch_recs, snakeCasifyObject as $g9l4l$snakeCasifyObject, GenericSliderArrowButton as $g9l4l$GenericSliderArrowButton, catchify as $g9l4l$catchify, instant_exec_on_suspect_history_change as $g9l4l$instant_exec_on_suspect_history_change, base_url as $g9l4l$base_url, get_depict_id as $g9l4l$get_depict_id, get_user_id as $g9l4l$get_user_id, get_session_id as $g9l4l$get_session_id, dlog as $g9l4l$dlog, make_url_with_query_params as $g9l4l$make_url_with_query_params, fetch_retry as $g9l4l$fetch_retry, add_version_query_params as $g9l4l$add_version_query_params, sort_obj as $g9l4l$sort_obj, Placeholder as $g9l4l$Placeholder, report as $g9l4l$report, javascript_media_query as $g9l4l$javascript_media_query, standard_price_format as $g9l4l$standard_price_format, make_random_classname as $g9l4l$make_random_classname, n_col_styling_with_dist as $g9l4l$n_col_styling_with_dist, observer as $g9l4l$observer, CrossIcon as $g9l4l$CrossIcon, useExpandingContainer as $g9l4l$useExpandingContainer, Amazing_Slider as $g9l4l$Amazing_Slider, slider_snap_css as $g9l4l$slider_snap_css, slider_fading_factory as $g9l4l$slider_fading_factory, MinusIcon as $g9l4l$MinusIcon, FilterIcon as $g9l4l$FilterIcon, SortIconAsc as $g9l4l$SortIconAsc, SortIconDesc as $g9l4l$SortIconDesc, PlusIcon as $g9l4l$PlusIcon, hsl_to_rgb as $g9l4l$hsl_to_rgb, relative_luminance_from_rgb as $g9l4l$relative_luminance_from_rgb, TickIcon as $g9l4l$TickIcon, ArrowUp as $g9l4l$ArrowUp, queueMacroTask as $g9l4l$queueMacroTask, dwarn as $g9l4l$dwarn, ContainedPlaceholderImage as $g9l4l$ContainedPlaceholderImage, BackIcon as $g9l4l$BackIcon, SearchIcon as $g9l4l$SearchIcon, Layout as $g9l4l$Layout, async_iterable_ipns as $g9l4l$async_iterable_ipns, make_asyncIterable_exiter as $g9l4l$make_asyncIterable_exiter, href_change_ipns as $g9l4l$href_change_ipns, ContainedImage as $g9l4l$ContainedImage, buildThresholdList as $g9l4l$buildThresholdList, deparallelize_no_drop as $g9l4l$deparallelize_no_drop, PreviousSearchIcon as $g9l4l$PreviousSearchIcon, insert_surfaces as $g9l4l$insert_surfaces} from "@depict-ai/utilishared";
+import {add_to_version_info as $g9l4l$add_to_version_info, fetch_recs as $g9l4l$fetch_recs, snakeCasifyObject as $g9l4l$snakeCasifyObject, GenericSliderArrowButton as $g9l4l$GenericSliderArrowButton, catchify as $g9l4l$catchify, instant_exec_on_suspect_history_change as $g9l4l$instant_exec_on_suspect_history_change, base_url as $g9l4l$base_url, dlog as $g9l4l$dlog, get_depict_id as $g9l4l$get_depict_id, get_user_id as $g9l4l$get_user_id, get_session_id as $g9l4l$get_session_id, make_url_with_query_params as $g9l4l$make_url_with_query_params, fetch_retry as $g9l4l$fetch_retry, add_version_query_params as $g9l4l$add_version_query_params, sort_obj as $g9l4l$sort_obj, Placeholder as $g9l4l$Placeholder, report as $g9l4l$report, javascript_media_query as $g9l4l$javascript_media_query, standard_price_format as $g9l4l$standard_price_format, make_random_classname as $g9l4l$make_random_classname, n_col_styling_with_dist as $g9l4l$n_col_styling_with_dist, observer as $g9l4l$observer, CrossIcon as $g9l4l$CrossIcon, useExpandingContainer as $g9l4l$useExpandingContainer, Amazing_Slider as $g9l4l$Amazing_Slider, slider_snap_css as $g9l4l$slider_snap_css, slider_fading_factory as $g9l4l$slider_fading_factory, MinusIcon as $g9l4l$MinusIcon, FilterIcon as $g9l4l$FilterIcon, SortIconAsc as $g9l4l$SortIconAsc, SortIconDesc as $g9l4l$SortIconDesc, PlusIcon as $g9l4l$PlusIcon, hsl_to_rgb as $g9l4l$hsl_to_rgb, relative_luminance_from_rgb as $g9l4l$relative_luminance_from_rgb, TickIcon as $g9l4l$TickIcon, ArrowUp as $g9l4l$ArrowUp, queueMacroTask as $g9l4l$queueMacroTask, dwarn as $g9l4l$dwarn, ContainedPlaceholderImage as $g9l4l$ContainedPlaceholderImage, BackIcon as $g9l4l$BackIcon, SearchIcon as $g9l4l$SearchIcon, Layout as $g9l4l$Layout, async_iterable_ipns as $g9l4l$async_iterable_ipns, make_asyncIterable_exiter as $g9l4l$make_asyncIterable_exiter, href_change_ipns as $g9l4l$href_change_ipns, ContainedImage as $g9l4l$ContainedImage, buildThresholdList as $g9l4l$buildThresholdList, deparallelize_no_drop as $g9l4l$deparallelize_no_drop, PreviousSearchIcon as $g9l4l$PreviousSearchIcon, insert_surfaces as $g9l4l$insert_surfaces} from "@depict-ai/utilishared";
 import {template as $g9l4l$template, insert as $g9l4l$insert, effect as $g9l4l$effect, setAttribute as $g9l4l$setAttribute, createComponent as $g9l4l$createComponent, use as $g9l4l$use, memo as $g9l4l$memo, addEventListener as $g9l4l$addEventListener, delegateEvents as $g9l4l$delegateEvents, spread as $g9l4l$spread, classList as $g9l4l$classList, style as $g9l4l$style, Dynamic as $g9l4l$Dynamic, mergeProps as $g9l4l$mergeProps, className as $g9l4l$className} from "solid-js/web";
 import {createSignal as $g9l4l$createSignal, onCleanup as $g9l4l$onCleanup, createComputed as $g9l4l$createComputed, createRenderEffect as $g9l4l$createRenderEffect, createEffect as $g9l4l$createEffect, untrack as $g9l4l$untrack, batch as $g9l4l$batch, createResource as $g9l4l$createResource, createMemo as $g9l4l$createMemo, Show as $g9l4l$Show, createReaction as $g9l4l$createReaction, Suspense as $g9l4l$Suspense, on as $g9l4l$on, createRoot as $g9l4l$createRoot, ErrorBoundary as $g9l4l$ErrorBoundary, For as $g9l4l$For, getOwner as $g9l4l$getOwner, runWithOwner as $g9l4l$runWithOwner, Index as $g9l4l$Index} from "solid-js";
 import {compressToBase64 as $g9l4l$compressToBase64, decompressFromBase64 as $g9l4l$decompressFromBase64} from "lz-string";
 
-/*! Depict.ai search and product listing SDK */ const $18bf1d29fb889cca$export$83d89fbfd8236492 = "0.0.83";
+/*! Depict.ai search and product listing SDK */ const $18bf1d29fb889cca$export$83d89fbfd8236492 = "1.0.1";
 
 
 
@@ -82,15 +82,6 @@ function $3075a4497054bec6$export$9862539c89138352(get_default_values_, router_)
 
 const $3846bb34098c738f$var$v2_base_url = (0, $g9l4l$base_url) + "/v2/";
 const $3846bb34098c738f$var$search_base_url = $3846bb34098c738f$var$v2_base_url + "search/";
-const $3846bb34098c738f$var$add_ids_to_request = (input_req)=>{
-    const request = {
-        ...input_req
-    };
-    request.dsid ??= (0, $g9l4l$get_depict_id)();
-    request.user_id ??= (0, $g9l4l$get_user_id)();
-    request.session_id ??= (0, $g9l4l$get_session_id)();
-    return request;
-};
 class $3846bb34098c738f$export$e015ed2f2950f2e3 {
     #supports_finalization_registry = typeof FinalizationRegistry === "function";
     #cache_objs = {};
@@ -105,12 +96,26 @@ class $3846bb34098c738f$export$e015ed2f2950f2e3 {
             })) : undefined
         };
     }
+    #add_ids_to_request = (input_req)=>{
+        const request = {
+            ...input_req
+        };
+        request.dsid ??= (0, $g9l4l$get_depict_id)();
+        // Todo: remove the default user and session IDs once we've confirmed backend can handle it and do whatever fallback is necessary.
+        request.user_id ??= this.#get_user_id?.() || (0, $g9l4l$get_user_id)();
+        request.session_id ??= this.#get_session_id?.() || (0, $g9l4l$get_session_id)();
+        return request;
+    };
     #get_metadata;
-    constructor(get_metadata){
+    #get_user_id;
+    #get_session_id;
+    constructor({ get_metadata: get_metadata , get_user_id: get_user_id , get_session_id: get_session_id  } = {}){
         this.#get_metadata = get_metadata;
+        this.#get_user_id = get_user_id;
+        this.#get_session_id = get_session_id;
     }
     async suggest(input_req) {
-        const request = $3846bb34098c738f$var$add_ids_to_request(input_req);
+        const request = this.#add_ids_to_request(input_req);
         const url = (0, $g9l4l$make_url_with_query_params)($3846bb34098c738f$var$search_base_url + "suggestions", request);
         const results = await (0, $g9l4l$fetch_retry)((0, $g9l4l$add_version_query_params)(url));
         attempt_to_return_api_response: {
@@ -127,7 +132,7 @@ class $3846bb34098c738f$export$e015ed2f2950f2e3 {
     }
     async #cached_post_request(endpoint1, input_req, fallback_response) {
         const cache_obj = this.#get_cache_obj_for_endpoint(endpoint1);
-        const with_ids = $3846bb34098c738f$var$add_ids_to_request(input_req);
+        const with_ids = this.#add_ids_to_request(input_req);
         const metaData = await this.#get_metadata?.();
         const request = metaData ? Object.assign(with_ids, {
             metadata: metaData
@@ -801,7 +806,8 @@ function $dc5df79ae78a9d00$export$f33414a4df0afd3f({ product_card_template_: pro
         if (!unwrapped_array?.length || !unwrapped_array.every((item)=>item)) // Haven't finished rendering yet in case of "async" rendering, so don't freeze the elements yet
         return;
         // placeholders have finished rendering, freeze the elements
-        $dc5df79ae78a9d00$var$cached_placeholder_element = get_cloned_placeholders(unwrapped_array); // Clone initial return value so that who gave us the elements can't mutate them, which has caused issues before with react
+        // here we might receive the result of a promise that has already been received, tore down and put into cached_placeholder_element, so don't overwrite that more valid result if it's already set
+        $dc5df79ae78a9d00$var$cached_placeholder_element ||= get_cloned_placeholders(unwrapped_array); // Clone initial return value so that who gave us the elements can't mutate them, which has caused issues before with react
         $dc5df79ae78a9d00$var$rendering_cached_placeholder_element = undefined;
         dispose_original_copy(); // So that this memo will never re-run and the placeholder rendering function can clean up
         return get_cloned_placeholders(); // clone, just in case. If we wouldn't, someone could modify the copy in the DOM, and it would affect the cached version

package/dist/typescript_schema/BaseSearchRequest.d.ts

@@ -0,0 +1,197 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An enumeration.
+ */
+export type SortingOrder = "asc" | "desc";
+
+export interface BaseSearchRequest {
+  tenant: string;
+  market: string;
+  /**
+   * List of filters to apply to the results.
+   */
+  filters?: SearchFilter[];
+  /**
+   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
+   */
+  sort?: SortModel;
+  /**
+   * User identifier
+   */
+  user_id?: string;
+  /**
+   * Session identifier
+   */
+  session_id?: string;
+  /**
+   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
+   */
+  dsid?: string;
+  /**
+   * Metadata that can be used to modify the behaviour of the search.
+   */
+  metadata?: {
+    [k: string]: string;
+  };
+  /**
+   * The search query.
+   */
+  query?: string;
+}
+export interface SearchFilter {
+  /**
+   * The field to filter by.
+   */
+  field: string;
+  /**
+   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
+   */
+  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
+  /**
+   * Data for the filter.
+   */
+  data?:
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | (
+        | ("true" | "false")
+        | number
+        | number
+        | string
+        | [number, number]
+        | [number, number]
+        | [number, number]
+        | [number, number]
+      )[]
+    | (("true" | "false") | number | number | string)[][];
+  /**
+   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
+   */
+  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
+  /**
+   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
+   */
+  id?: string;
+}
+export interface RangeFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "range";
+  /**
+   * The minimum value that can be selected in the range.
+   */
+  min: number;
+  /**
+   * The maximum value that can be selected in the range.
+   */
+  max: number;
+  /**
+   * The unit of the range values.
+   */
+  unit?: string;
+  /**
+   * The currency of the range values.
+   */
+  currency?: string;
+}
+export interface ValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  /**
+   * Type of filter.
+   */
+  type?: "radio" | "checkbox" | "checkbox-grid";
+  /**
+   * Selectable values
+   */
+  values: (
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+  )[];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for values
+   */
+  names?: string[];
+}
+export interface HierarchicalValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "checkbox-hierarchical";
+  /**
+   * Selectable hierarchical values
+   */
+  values: (("true" | "false") | number | number | string)[][];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for hierarchical values
+   */
+  names?: string[];
+}
+export interface SortModel {
+  /**
+   * The field to sort by.
+   */
+  field: string;
+  /**
+   * The order to sort by.
+   */
+  order: SortingOrder;
+  /**
+   * Metadata about the sort that can be used for rendering.
+   */
+  meta?: SortMeta;
+}
+export interface SortMeta {
+  title: string;
+  /**
+   * Selectable values
+   */
+  values?: SortingOrder[];
+  /**
+   * Names for orders
+   */
+  names?: string[];
+}

package/dist/typescript_schema/ProductListingQueriesRequest.d.ts

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface ProductListingQueriesRequest {
+  tenant: string;
+  market: string;
+  metadata?: {
+    [k: string]: string;
+  };
+}

package/dist/typescript_schema/ProductListingQueriesResponse.d.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface ProductListingQueriesResponse {
+  query_ids?: string[];
+}

package/dist/typescript_schema/ProductListingRequest.d.ts

@@ -0,0 +1,221 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An enumeration.
+ */
+export type SortingOrder = "asc" | "desc";
+
+export interface ProductListingRequest {
+  /**
+   * Deprecated, do not use. Will be removed.
+   */
+  page?: number;
+  /**
+   * Deprecated, do not use. Will be removed.
+   */
+  hits_per_page?: number;
+  /**
+   * Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
+   */
+  cursor?: string;
+  /**
+   * Maximum number of results per response.
+   */
+  limit?: number;
+  tenant: string;
+  market: string;
+  /**
+   * List of filters to apply to the results.
+   */
+  filters?: SearchFilter[];
+  /**
+   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
+   */
+  sort?: SortModel;
+  /**
+   * User identifier
+   */
+  user_id?: string;
+  /**
+   * Session identifier
+   */
+  session_id?: string;
+  /**
+   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
+   */
+  dsid?: string;
+  /**
+   * Metadata that can be used to modify the behaviour of the search.
+   */
+  metadata?: {
+    [k: string]: string;
+  };
+  /**
+   * ID of the page to get products for. This is typically the slug, for example `hoodies-and-sweaters`.
+   */
+  query_id: string;
+  /**
+   * Disables rules to hide products.
+   */
+  show_hidden_products?: boolean;
+  /**
+   * Whether to return grouping IDs or not.
+   */
+  return_grouping_ids?: boolean;
+}
+export interface SearchFilter {
+  /**
+   * The field to filter by.
+   */
+  field: string;
+  /**
+   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
+   */
+  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
+  /**
+   * Data for the filter.
+   */
+  data?:
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | (
+        | ("true" | "false")
+        | number
+        | number
+        | string
+        | [number, number]
+        | [number, number]
+        | [number, number]
+        | [number, number]
+      )[]
+    | (("true" | "false") | number | number | string)[][];
+  /**
+   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
+   */
+  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
+  /**
+   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
+   */
+  id?: string;
+}
+export interface RangeFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "range";
+  /**
+   * The minimum value that can be selected in the range.
+   */
+  min: number;
+  /**
+   * The maximum value that can be selected in the range.
+   */
+  max: number;
+  /**
+   * The unit of the range values.
+   */
+  unit?: string;
+  /**
+   * The currency of the range values.
+   */
+  currency?: string;
+}
+export interface ValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  /**
+   * Type of filter.
+   */
+  type?: "radio" | "checkbox" | "checkbox-grid";
+  /**
+   * Selectable values
+   */
+  values: (
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+  )[];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for values
+   */
+  names?: string[];
+}
+export interface HierarchicalValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "checkbox-hierarchical";
+  /**
+   * Selectable hierarchical values
+   */
+  values: (("true" | "false") | number | number | string)[][];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for hierarchical values
+   */
+  names?: string[];
+}
+export interface SortModel {
+  /**
+   * The field to sort by.
+   */
+  field: string;
+  /**
+   * The order to sort by.
+   */
+  order: SortingOrder;
+  /**
+   * Metadata about the sort that can be used for rendering.
+   */
+  meta?: SortMeta;
+}
+export interface SortMeta {
+  title: string;
+  /**
+   * Selectable values
+   */
+  values?: SortingOrder[];
+  /**
+   * Names for orders
+   */
+  names?: string[];
+}