@depict-ai/ui 1.4.10 → 1.4.12

package/server/latest/index.cjs

@@ -54,7 +54,7 @@ $parcel$export(module.exports, "defaultColsAtSize", () => $a3280f0aad997933$expo
 $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad997933$export$7bf543b9d9be2c22);
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
 /*! Depict.ai search and product listing SDK */
-const $b757f75811f3261f$export$83d89fbfd8236492 = "1.4.10";
+const $b757f75811f3261f$export$83d89fbfd8236492 = "1.4.12";
 function $4b455f60dadde8b8$export$5bad61ecde080b1f(...params) {
   const {
     collapse: collapse,
@@ -4562,11 +4562,10 @@ function $840d88a04b2d22a7$export$f7d2f673fc2f091d({
   const crumb_data_ = (0, $5vyXB$solidjs.createMemo)(() => plp_results_()?.breadcrumb);
   const quicklinks_data_ = (0, $5vyXB$solidjs.createMemo)(() => plp_results_()?.quick_links);
   const meta_tag_data_ = (0, $5vyXB$solidjs.createMemo)(() => {
-    meta_title_suffix_();
-    return plp_results_()?.metadata?.replace_meta_tags ? {
+    if (plp_results_()?.metadata?.replace_meta_tags) return {
       title: plp_results_()?.metadata?.title + (meta_title_suffix_() || ""),
       description: plp_results_()?.metadata?.description
-    } : null;
+    };
   });
   (0, $5vyXB$depictaiutilishared.edit_current_page_meta_tags)(meta_tag_data_);
   const [sort_or_filter_open_, set_sort_or_filter_open_] = (0, $5vyXB$solidjs.createSignal)(false);
@@ -4856,8 +4855,12 @@ function $c79fd10a3ab7d6e0$export$477caf01aecaeb2a(options) {
   const router_ = options.router_;
   const search_query_url_param_name_ = "search_query_url_param_name_" in options ? options.search_query_url_param_name_ : undefined;
   const search_query_ = search_query_url_param_name_ ? (0, $5vyXB$solidjs.createSignal)("") : undefined;
+  const override_query_id_query_param_names_ = "override_query_id_query_param_names_" in options ? options.override_query_id_query_param_names_ : undefined;
+  const override_query_id_ = override_query_id_query_param_names_ ? (0, $5vyXB$solidjs.createSignal)(null) : undefined;
   const get_search_query_ = search_query_?.[0];
   const set_search_query = search_query_?.[1];
+  const get_override_query_id_ = override_query_id_?.[0];
+  const set_override_query_id = override_query_id_?.[1];
   const current_sorting_ = (0, $5vyXB$solidjs.createSignal)();
   const selected_filters_ = (0, $5vyXB$solidjs.createSignal)([]);
   const sideways_filter_clearing_flag_ = (0, $5vyXB$solidjs.createSignal)(false);
@@ -4902,6 +4905,12 @@ function $c79fd10a3ab7d6e0$export$477caf01aecaeb2a(options) {
         const found_query = searchParams.get(search_query_url_param_name_);
         set_search_query(found_query || "");
       }
+      if (override_query_id_query_param_names_) {
+        const found_override_query_id = override_query_id_query_param_names_.map(n => searchParams.get(n)).find(n => n);
+        set_override_query_id(found_override_query_id || null);
+        if (found_override_query_id) (0, $5vyXB$depictaiutilishared.dlog)("Found override query id:", found_override_query_id); // This stuff might get confusing so better log it
+      }
+
       if (searchParams.get((0, $1ab22f2cd39b3061$export$cf5feb2102aec7f2)) === "true") set_has_sideways_filter_clearing_flag(true);
       if (!writer_started) {
         // The owner here is the createComputed which gets disposed the next time the computation runs - but we actually just want to delay the start of the href_writer until our signals contain the current value of the URL, therefore the runWithOwner
@@ -4925,7 +4934,10 @@ function $c79fd10a3ab7d6e0$export$477caf01aecaeb2a(options) {
       search_query_accessor_: get_search_query_
     } : {
       sideways_filter_clearing_flag_: sideways_filter_clearing_flag_
-    })
+    }),
+    ...(typeof override_query_id_query_param_names_ === "object" ? {
+      override_query_id_accessor_: get_override_query_id_
+    } : {})
   };
 }
 /**
@@ -5106,6 +5118,7 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
   #market_signal = (0, $5vyXB$solidjs.createSignal)();
   #query_id_signal = (0, $5vyXB$solidjs.createSignal)("");
   #meta_title_suffix_ = (0, $5vyXB$solidjs.createSignal)();
+  #disable_override_query_id = (0, $5vyXB$solidjs.createSignal)();
   #listing_type_signal = (0, $5vyXB$solidjs.createSignal)();
   static #keys_constructed_with = new Set();
   get localization() {
@@ -5145,6 +5158,12 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
   set meta_title_suffix(new_suffix) {
     this.#meta_title_suffix_[1](new_suffix);
   }
+  get disable_override_query_id() {
+    return this.#disable_override_query_id[0]();
+  }
+  set disable_override_query_id(new_value) {
+    this.#disable_override_query_id[1](new_value);
+  }
   get on_navigation() {
     // The only non-reactive public property on the class (I don't see it making sense to have it reactive)
     return this.#router.on_navigation_;
@@ -5170,16 +5189,19 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
       (0, $d84fe647b84b5dc5$export$5162a71f252e6122)();
       this.#router = new (0, $e96dd13889871fc0$export$7e1297a3a19f10d8)("hard_navigation", query_id_state_key);
       if (on_navigation) this.#router.on_navigation_ = on_navigation;
+      const override_query_id_query_param_names_ = ["query_id_" + unique_instance_key_for_state, "query_id"]; // If you're wondering why this is an array https://gitlab.com/depict-ai/depict.ai/-/merge_requests/7958#note_1511700842
       const sorting_query_param_ = "sorting" + unique_instance_key_for_state;
       const filter_query_param_prefix_ = "f" + unique_instance_key_for_state + "_";
       const {
         selected_filters_: selected_filters_,
         current_sorting_: current_sorting_,
-        sideways_filter_clearing_flag_: sideways_filter_clearing_flag_
+        sideways_filter_clearing_flag_: sideways_filter_clearing_flag_,
+        override_query_id_accessor_: override_query_id_accessor_
       } = (0, $c79fd10a3ab7d6e0$export$477caf01aecaeb2a)({
         router_: this.#router,
         sorting_query_param_: sorting_query_param_,
-        filter_query_param_prefix_: filter_query_param_prefix_
+        filter_query_param_prefix_: filter_query_param_prefix_,
+        override_query_id_query_param_names_: override_query_id_query_param_names_
       });
       const [reset_history_state_, state_] = (0, $26a56f6b44703084$export$9862539c89138352)({
         get_default_values_: () => ({
@@ -5209,6 +5231,7 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
         router_: this.#router,
         selected_filters_: selected_filters_,
         current_sorting_: current_sorting_,
+        override_query_id_accessor_: override_query_id_accessor_,
         sideways_filter_clearing_flag_: sideways_filter_clearing_flag_,
         sorting_query_param_: sorting_query_param_,
         filter_query_param_prefix_: filter_query_param_prefix_
@@ -5255,6 +5278,7 @@ function $48567ac5b39bac56$export$e2bf8ce7779e827e(props) {
       },
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
+      override_query_id_accessor_: override_query_id_accessor_,
       reset_history_state_: reset_history_state_,
       depict_api_: depict_api_,
       i18n_: i18n_,
@@ -5272,8 +5296,8 @@ function $48567ac5b39bac56$export$e2bf8ce7779e827e(props) {
       depict_api_: depict_api_,
       min_products_to_fetch_: $48567ac5b39bac56$var$min_products_to_fetch_,
       local_filter_cache_: local_filter_cache_,
+      query_id_: (0, $5vyXB$solidjs.createMemo)(() => !depict_category.disable_override_query_id && override_query_id_accessor_() || depict_category.category_id),
       meta_title_suffix_: () => depict_category.meta_title_suffix,
-      query_id_: () => depict_category.category_id,
       listing_type_: () => depict_category.listing_type,
       i18n_: i18n_,
       show_quicklinks_: (0, $5vyXB$solidjs.createMemo)(() => props.show_quicklinks ?? true),

package/server/latest/index.d.ts

@@ -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.10";
+export const version = "1.4.12";
 export function ExpandingDetails(props: {
   details_: HTMLDetailsElement;
   summary_: HTMLElement;
@@ -550,6 +550,8 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
   set listing_type(listing_type: ListingType | undefined);
   get meta_title_suffix(): string | undefined;
   set meta_title_suffix(new_suffix: string | undefined);
+  get disable_override_query_id(): boolean | undefined;
+  set disable_override_query_id(new_value: boolean | undefined);
   get on_navigation(): OnNavigation;
   set on_navigation(new_function: OnNavigation);
   constructor({
@@ -562,6 +564,11 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
     ...props_on_class
   }: DepictCategoryConstructorOptions<InputDisplay, OutputDisplay>);
 }
+/**
+ * This is the CategoryPage component visible outside - exported from @depict-ai/ui.
+ * It wraps the internal, pure CategoryPage component and connects it to the DepictCategory instance and other global state such as the history or page URL.
+ * It is wrapped once again in the js-ui and react-ui packages which exports the final, most simplified interface.
+ */
 export function CategoryPage<OriginalDisplay extends Display, OutputDisplay extends ModernDisplay | never>(props: {
   depict_category: DepictCategory<OriginalDisplay, OutputDisplay>;
   grid_spacing: SDKGridSpacing;
@@ -697,6 +704,11 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
   set market(market: string);
   fetchSearchResults(query: string, filters?: SearchFilter[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
 }
+/**
+ * This is the SearchPage component visible outside - exported from @depict-ai/ui.
+ * It wraps the internal, pure SearchPage component and connects it to the DepictSearch instance and other global state such as the history or page URL.
+ * It is wrapped once again in the js-ui and react-ui packages which exports the final, most simplified interface.
+ */
 export function SearchPage<OriginalDisplay extends Display, TransformedDisplay extends never | ModernDisplay>(props: {
   depict_search: DepictSearch<OriginalDisplay, TransformedDisplay>;
   include_input_field?: boolean | {
@@ -819,9 +831,18 @@ export type BaseSearchProviderConfig = {
 };
 export type BaseCategoryProviderConfig = {
   /**
-   * Currently used for SEO long tail only. Example: {generatedTitle} + {metaTitleSuffix}
+   * 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 `query_id=` will override the regular category id that you have configured your SDK to use. You can consider the `query_id` as an escape-hatch if you want to easily set a category id.
+   * However, if your page already sets a query_id, you can disable this behaviour by setting this property to `true` (to avoid a conflict).
+   */
+  disableOverrideQueryId?: boolean;
 };
 export interface BaseProductListingConfig {
   /**

package/server/latest/index.js

@@ -5,7 +5,7 @@ import { createSignal as $i7OB2$createSignal, createMemo as $i7OB2$createMemo, u
 /*! Depict.ai search and product listing SDK */
 import { register_es_version } from "../../multi_import_deduplicator.mjs";
 register_es_version("ui", "latest");
-const $ec291e0010116877$export$83d89fbfd8236492 = "1.4.10";
+const $ec291e0010116877$export$83d89fbfd8236492 = "1.4.12";
 function $24e27fab9c821b86$export$5bad61ecde080b1f(...params) {
   const {
     collapse: collapse,
@@ -4513,11 +4513,10 @@ function $df5d81d0fe61ff21$export$f7d2f673fc2f091d({
   const crumb_data_ = (0, $i7OB2$createMemo)(() => plp_results_()?.breadcrumb);
   const quicklinks_data_ = (0, $i7OB2$createMemo)(() => plp_results_()?.quick_links);
   const meta_tag_data_ = (0, $i7OB2$createMemo)(() => {
-    meta_title_suffix_();
-    return plp_results_()?.metadata?.replace_meta_tags ? {
+    if (plp_results_()?.metadata?.replace_meta_tags) return {
       title: plp_results_()?.metadata?.title + (meta_title_suffix_() || ""),
       description: plp_results_()?.metadata?.description
-    } : null;
+    };
   });
   (0, $i7OB2$edit_current_page_meta_tags)(meta_tag_data_);
   const [sort_or_filter_open_, set_sort_or_filter_open_] = (0, $i7OB2$createSignal)(false);
@@ -4807,8 +4806,12 @@ function $ccd5db07a3a069c5$export$477caf01aecaeb2a(options) {
   const router_ = options.router_;
   const search_query_url_param_name_ = "search_query_url_param_name_" in options ? options.search_query_url_param_name_ : undefined;
   const search_query_ = search_query_url_param_name_ ? (0, $i7OB2$createSignal)("") : undefined;
+  const override_query_id_query_param_names_ = "override_query_id_query_param_names_" in options ? options.override_query_id_query_param_names_ : undefined;
+  const override_query_id_ = override_query_id_query_param_names_ ? (0, $i7OB2$createSignal)(null) : undefined;
   const get_search_query_ = search_query_?.[0];
   const set_search_query = search_query_?.[1];
+  const get_override_query_id_ = override_query_id_?.[0];
+  const set_override_query_id = override_query_id_?.[1];
   const current_sorting_ = (0, $i7OB2$createSignal)();
   const selected_filters_ = (0, $i7OB2$createSignal)([]);
   const sideways_filter_clearing_flag_ = (0, $i7OB2$createSignal)(false);
@@ -4853,6 +4856,12 @@ function $ccd5db07a3a069c5$export$477caf01aecaeb2a(options) {
         const found_query = searchParams.get(search_query_url_param_name_);
         set_search_query(found_query || "");
       }
+      if (override_query_id_query_param_names_) {
+        const found_override_query_id = override_query_id_query_param_names_.map(n => searchParams.get(n)).find(n => n);
+        set_override_query_id(found_override_query_id || null);
+        if (found_override_query_id) (0, $i7OB2$dlog)("Found override query id:", found_override_query_id); // This stuff might get confusing so better log it
+      }
+
       if (searchParams.get((0, $4147651646da990a$export$cf5feb2102aec7f2)) === "true") set_has_sideways_filter_clearing_flag(true);
       if (!writer_started) {
         // The owner here is the createComputed which gets disposed the next time the computation runs - but we actually just want to delay the start of the href_writer until our signals contain the current value of the URL, therefore the runWithOwner
@@ -4876,7 +4885,10 @@ function $ccd5db07a3a069c5$export$477caf01aecaeb2a(options) {
       search_query_accessor_: get_search_query_
     } : {
       sideways_filter_clearing_flag_: sideways_filter_clearing_flag_
-    })
+    }),
+    ...(typeof override_query_id_query_param_names_ === "object" ? {
+      override_query_id_accessor_: get_override_query_id_
+    } : {})
   };
 }
 /**
@@ -5057,6 +5069,7 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
   #market_signal = (0, $i7OB2$createSignal)();
   #query_id_signal = (0, $i7OB2$createSignal)("");
   #meta_title_suffix_ = (0, $i7OB2$createSignal)();
+  #disable_override_query_id = (0, $i7OB2$createSignal)();
   #listing_type_signal = (0, $i7OB2$createSignal)();
   static #keys_constructed_with = new Set();
   get localization() {
@@ -5096,6 +5109,12 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
   set meta_title_suffix(new_suffix) {
     this.#meta_title_suffix_[1](new_suffix);
   }
+  get disable_override_query_id() {
+    return this.#disable_override_query_id[0]();
+  }
+  set disable_override_query_id(new_value) {
+    this.#disable_override_query_id[1](new_value);
+  }
   get on_navigation() {
     // The only non-reactive public property on the class (I don't see it making sense to have it reactive)
     return this.#router.on_navigation_;
@@ -5121,16 +5140,19 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
       (0, $90980bd87c9960f9$export$5162a71f252e6122)();
       this.#router = new (0, $4fd2ba03703a7d92$export$7e1297a3a19f10d8)("hard_navigation", query_id_state_key);
       if (on_navigation) this.#router.on_navigation_ = on_navigation;
+      const override_query_id_query_param_names_ = ["query_id_" + unique_instance_key_for_state, "query_id"]; // If you're wondering why this is an array https://gitlab.com/depict-ai/depict.ai/-/merge_requests/7958#note_1511700842
       const sorting_query_param_ = "sorting" + unique_instance_key_for_state;
       const filter_query_param_prefix_ = "f" + unique_instance_key_for_state + "_";
       const {
         selected_filters_: selected_filters_,
         current_sorting_: current_sorting_,
-        sideways_filter_clearing_flag_: sideways_filter_clearing_flag_
+        sideways_filter_clearing_flag_: sideways_filter_clearing_flag_,
+        override_query_id_accessor_: override_query_id_accessor_
       } = (0, $ccd5db07a3a069c5$export$477caf01aecaeb2a)({
         router_: this.#router,
         sorting_query_param_: sorting_query_param_,
-        filter_query_param_prefix_: filter_query_param_prefix_
+        filter_query_param_prefix_: filter_query_param_prefix_,
+        override_query_id_query_param_names_: override_query_id_query_param_names_
       });
       const [reset_history_state_, state_] = (0, $a8fa7302d6f93c0b$export$9862539c89138352)({
         get_default_values_: () => ({
@@ -5160,6 +5182,7 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
         router_: this.#router,
         selected_filters_: selected_filters_,
         current_sorting_: current_sorting_,
+        override_query_id_accessor_: override_query_id_accessor_,
         sideways_filter_clearing_flag_: sideways_filter_clearing_flag_,
         sorting_query_param_: sorting_query_param_,
         filter_query_param_prefix_: filter_query_param_prefix_
@@ -5206,6 +5229,7 @@ function $961b5c64bef4662f$export$e2bf8ce7779e827e(props) {
       },
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
+      override_query_id_accessor_: override_query_id_accessor_,
       reset_history_state_: reset_history_state_,
       depict_api_: depict_api_,
       i18n_: i18n_,
@@ -5223,8 +5247,8 @@ function $961b5c64bef4662f$export$e2bf8ce7779e827e(props) {
       depict_api_: depict_api_,
       min_products_to_fetch_: $961b5c64bef4662f$var$min_products_to_fetch_,
       local_filter_cache_: local_filter_cache_,
+      query_id_: (0, $i7OB2$createMemo)(() => !depict_category.disable_override_query_id && override_query_id_accessor_() || depict_category.category_id),
       meta_title_suffix_: () => depict_category.meta_title_suffix,
-      query_id_: () => depict_category.category_id,
       listing_type_: () => depict_category.listing_type,
       i18n_: i18n_,
       show_quicklinks_: (0, $i7OB2$createMemo)(() => props.show_quicklinks ?? true),