@depict-ai/ui 0.0.53 → 0.0.54

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestions
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
 import { ProductListingResponse, BaseCategoryDisplay } from "@depict-ai/types/api/ProductListingResponse";
 import { JSX as _JSX1 } from "solid-js/types/jsx";
-export const version = "0.0.53";
+export const version = "0.0.54";
 type ExclusiveId = {
     categoryId: string;
     productId?: undefined;
@@ -349,6 +349,61 @@ interface SearchFieldParams {
     aligner_ref?: HTMLElement | null;
 }
 export function SearchField({ depict_search, modal_dispose_handler, click_handler, aligner_ref, }: SearchFieldParams): Node_Array;
+export type DepictBaseConfig = {
+    /**
+     * 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;
+};
+export type DepictSearchConfig = {
+    /**
+     * 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"
+     * @default "search_query"
+     */
+    urlParamName?: string;
+    /**
+     * Whether to enable category suggestions in the search modal and search page.
+     * @default false
+     */
+    enableCategorySuggestions?: boolean;
+};
+export interface BaseSearchPageConfig extends BasePLPConfig {
+    /**
+     * Whether to show the search input field in the search page.
+     * @default true
+     */
+    includeInputField?: boolean;
+}
+export interface BasePLPConfig {
+    /**
+     * 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;
+}
 type CenteredLocation = {
     location?: "centered";
 };

package/dist/main.js

@@ -33,7 +33,7 @@ $parcel$export(module.exports, "solid_format_price", () => $5fc9fc23df1591db$exp
 $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.53";
+/*! Depict.ai search and product listing SDK */ const $ae93561d5649a847$export$83d89fbfd8236492 = "0.0.54";
 
 
 
@@ -5074,7 +5074,7 @@ function $068a627cc18f7bb6$var$get_shared_properties(depict_category) {
 
 
 
-const $853f821e60bd06ea$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$46MJV$solidjsweb.template)(`<div class="category-title"><h2 class="title"></h2><span class="explanation"> — </span></div>`, 6);
+const $853f821e60bd06ea$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$46MJV$solidjsweb.template)(`<div class="category-title"><h1 class="title"></h1><span class="explanation"> — </span></div>`, 6);
 const $853f821e60bd06ea$export$b91cec6bdc6b32a1 = /*@__PURE__*/ (()=>{
     const actual_function = ({ category_title_: category_title_ , product_count_: product_count_  })=>{
         return (()=>{

package/dist/module.js

@@ -2,7 +2,7 @@ import {add_to_version_info as $g9l4l$add_to_version_info, fetch_recs as $g9l4l$
 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, addEventListener as $g9l4l$addEventListener, delegateEvents as $g9l4l$delegateEvents, spread as $g9l4l$spread, memo as $g9l4l$memo, style as $g9l4l$style, mergeProps as $g9l4l$mergeProps, classList as $g9l4l$classList, className as $g9l4l$className} from "solid-js/web";
 import {createSignal as $g9l4l$createSignal, onCleanup as $g9l4l$onCleanup, createComputed as $g9l4l$createComputed, createEffect as $g9l4l$createEffect, untrack as $g9l4l$untrack, batch as $g9l4l$batch, createResource as $g9l4l$createResource, createMemo as $g9l4l$createMemo, Show as $g9l4l$Show, createRenderEffect as $g9l4l$createRenderEffect, runWithOwner as $g9l4l$runWithOwner, createRoot as $g9l4l$createRoot, getOwner as $g9l4l$getOwner, on as $g9l4l$on, Index as $g9l4l$Index, For as $g9l4l$For, ErrorBoundary as $g9l4l$ErrorBoundary} from "solid-js";
 
-/*! Depict.ai search and product listing SDK */ const $18bf1d29fb889cca$export$83d89fbfd8236492 = "0.0.53";
+/*! Depict.ai search and product listing SDK */ const $18bf1d29fb889cca$export$83d89fbfd8236492 = "0.0.54";
 
 
 
@@ -5043,7 +5043,7 @@ function $ec52ef1e6c117813$var$get_shared_properties(depict_category) {
 
 
 
-const $6340962f8bafd049$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$g9l4l$template)(`<div class="category-title"><h2 class="title"></h2><span class="explanation"> — </span></div>`, 6);
+const $6340962f8bafd049$var$_tmpl$ = /*@__PURE__*/ (0, /*@__PURE__*/$g9l4l$template)(`<div class="category-title"><h1 class="title"></h1><span class="explanation"> — </span></div>`, 6);
 const $6340962f8bafd049$export$b91cec6bdc6b32a1 = /*@__PURE__*/ (()=>{
     const actual_function = ({ category_title_: category_title_ , product_count_: product_count_  })=>{
         return (()=>{

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[];
+}