@depict-ai/ui 4.0.27 → 4.1.0

package/ES10/index.cjs

@@ -98,7 +98,7 @@ $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $33eed84f447a
 $parcel$export(module.exports, "version", () => $aa1938dec50d6c12$export$83d89fbfd8236492);
 $parcel$export(module.exports, "SearchField", () => $98aef9965764903d$export$316f6f283ae64765);
 /*! Depict.ai search and product listing SDK */
-const $aa1938dec50d6c12$export$83d89fbfd8236492 = "4.0.27";
+const $aa1938dec50d6c12$export$83d89fbfd8236492 = "4.1.0";
 const $cfcd56242923775d$export$3064e1e8c6513da3 = new Set();
 let $cfcd56242923775d$var$has_ran = false;
 function $cfcd56242923775d$export$5162a71f252e6122() {
@@ -12440,11 +12440,19 @@ var $9cbefc32b9dab36d$var$_market_signal = /*#__PURE__*/new WeakMap();
 var $9cbefc32b9dab36d$var$_listing_query_signal = /*#__PURE__*/new WeakMap();
 var $9cbefc32b9dab36d$var$_disable_override_listing_id = /*#__PURE__*/new WeakMap();
 class $9cbefc32b9dab36d$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   get localization() {
     // allow reactive access
     return $parcel$interopDefault($52FdA$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $parcel$interopDefault($52FdA$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[1](locale_obj);
   }
   get listing_query() {
@@ -12487,6 +12495,8 @@ class $9cbefc32b9dab36d$export$f34314aa9505732e {
       listing_query_state_key: listing_query_state_key,
       ...props_on_class
     } = _ref2;
+    $parcel$interopDefault($52FdA$babelruntimehelpersdefineProperty)(this, "historyStateSignals_", void 0);
+    $parcel$interopDefault($52FdA$babelruntimehelpersdefineProperty)(this, "selectedFilters_", void 0);
     $9cbefc32b9dab36d$var$_classPrivateFieldInitSpec(this, $9cbefc32b9dab36d$var$_router, {
       writable: true,
       value: void 0
@@ -12548,8 +12558,9 @@ class $9cbefc32b9dab36d$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $39cca429fb71d8ff$export$f091cbac892643a4($parcel$interopDefault($52FdA$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $9cbefc32b9dab36d$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $52FdA$solidjs.createSignal(),
         quicklinks_signal_: $52FdA$solidjs.createSignal(),
         i18n_: i18n_,
@@ -12615,14 +12626,14 @@ function $9cbefc32b9dab36d$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -14619,6 +14630,9 @@ class $ddd39c5f36f49703$export$ac6237957a15b3f0 {
     return $parcel$interopDefault($52FdA$babelruntimehelpersclassPrivateFieldGet)(this, $ddd39c5f36f49703$var$_locale_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $parcel$interopDefault($52FdA$babelruntimehelpersclassPrivateFieldGet)(this, $ddd39c5f36f49703$var$_locale_signal)[1](locale_obj);
   }
   get modal_open() {

package/ES10/index.d.ts

@@ -4,13 +4,13 @@ import { SearchFilter, SearchRequestV3, SortModel } from "@depict-ai/types/api/S
 import { ContentLink, SearchResponse, SearchFilter as _SearchFilter1 } from "@depict-ai/types/api/SearchResponse";
 import { Ancestors, ListingSuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
 import { ProductListing, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
-import { ProductListingResponseV3 } from "@depict-ai/types/api/ProductListingResponseV3";
+import { ProductListingResponseV3, SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/ProductListingResponseV3";
 import { SearchSuggestionsRequestV3 } from "@depict-ai/types/api/SearchSuggestionsRequestV3";
 import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequestV3";
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
-import { SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "4.0.27";
+import { SearchFilter as _SearchFilter3 } from "@depict-ai/types/api/SearchRequestV2";
+export const version = "4.1.0";
 export const prefixes_to_preserve_in_history_dot_state: Set<string>;
 /**
  * Prevent, usually SPAs, from deleting our stuff from history.state when they call history.pushState with a new object they have constructed. This will only run once no matter how often it's called.
@@ -78,12 +78,16 @@ export function createDeparallelizedNoDropResource<T, X>(dependency: Accessor<T
 export function throw_globally<T extends (...args: any) => any>(fn?: T): (...args: Parameters<T>) => ReturnType<T> | undefined;
 declare const LISTING_ID = "listingId";
 declare const EXTERNAL_ID = "externalId";
+type ScrollRestorationData = {
+  min_results_loaded: number;
+  for_id: string;
+}[];
 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 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.
@@ -667,7 +671,7 @@ export type BaseSearchProviderConfig<InputDisplay extends Display, PossibleTrans
   urlParamName?: string;
   /**
    * Whether to enable category suggestions in the search modal and search page.
-   * @default false
+   * @default true
    */
   enableCategorySuggestions?: boolean;
   /**
@@ -1184,6 +1188,27 @@ type CategoryConstructorOptionsWithoutApi<InputDisplay extends Display, OutputDi
 type DepictCategoryConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = CategoryConstructorOptionsWithApi<InputDisplay, OutputDisplay> | CategoryConstructorOptionsWithoutApi<InputDisplay, OutputDisplay>;
 export class DepictCategory<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
+  /**
+   * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+   */
+  historyStateSignals_: {
+    filters_open: Signal<boolean>;
+    sorting_open: Signal<boolean>;
+    expanded_filters: Signal<{
+      section_: string;
+      expanded_: boolean;
+    }[]>;
+    local_filter_cache: Signal<_SearchFilter2[]>;
+    expanded_hierarchical_filters: Signal<{
+      value_: string[];
+      expanded_: boolean;
+    }[]>;
+    scroll_restoration_data: Signal<ScrollRestorationData>;
+  };
+  /**
+   * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+   */
+  selectedFilters_: Signal<FilterWithData[]>;
   get localization(): category_i18n;
   set localization(locale_obj: category_i18n);
   get listing_query(): ListingQuery;
@@ -1301,7 +1326,7 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
   set merchant(tenant: string);
   get market(): string;
   set market(market: string);
-  fetchSearchResults(query: string, filters?: _SearchFilter2[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
+  fetchSearchResults(query: string, filters?: _SearchFilter3[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
 }
 /**
  * This is the SearchPage component visible outside - exported from @depict-ai/ui.

package/ES10/index.js

@@ -10,7 +10,7 @@ import { createStore as $8tj43$createStore, reconcile as $8tj43$reconcile } from
 /*! Depict.ai search and product listing SDK */
 import { register_es_version } from "../multi_import_deduplicator.mjs";
 register_es_version("ui", "ES10");
-const $8db9a15135765c11$export$83d89fbfd8236492 = "4.0.27";
+const $8db9a15135765c11$export$83d89fbfd8236492 = "4.1.0";
 const $68e6625c8d51f847$export$3064e1e8c6513da3 = new Set();
 let $68e6625c8d51f847$var$has_ran = false;
 function $68e6625c8d51f847$export$5162a71f252e6122() {
@@ -12352,11 +12352,19 @@ var $f5f54892fd0c7d9f$var$_market_signal = /*#__PURE__*/new WeakMap();
 var $f5f54892fd0c7d9f$var$_listing_query_signal = /*#__PURE__*/new WeakMap();
 var $f5f54892fd0c7d9f$var$_disable_override_listing_id = /*#__PURE__*/new WeakMap();
 class $f5f54892fd0c7d9f$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   get localization() {
     // allow reactive access
     return $8tj43$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $8tj43$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[1](locale_obj);
   }
   get listing_query() {
@@ -12399,6 +12407,8 @@ class $f5f54892fd0c7d9f$export$f34314aa9505732e {
       listing_query_state_key: listing_query_state_key,
       ...props_on_class
     } = _ref2;
+    $8tj43$babelruntimehelpersdefineProperty(this, "historyStateSignals_", void 0);
+    $8tj43$babelruntimehelpersdefineProperty(this, "selectedFilters_", void 0);
     $f5f54892fd0c7d9f$var$_classPrivateFieldInitSpec(this, $f5f54892fd0c7d9f$var$_router, {
       writable: true,
       value: void 0
@@ -12460,8 +12470,9 @@ class $f5f54892fd0c7d9f$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $e18ab2868df26f40$export$f091cbac892643a4($8tj43$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $f5f54892fd0c7d9f$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $8tj43$createSignal(),
         quicklinks_signal_: $8tj43$createSignal(),
         i18n_: i18n_,
@@ -12527,14 +12538,14 @@ function $f5f54892fd0c7d9f$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -14531,6 +14542,9 @@ class $eb064bc3350276c1$export$ac6237957a15b3f0 {
     return $8tj43$babelruntimehelpersclassPrivateFieldGet(this, $eb064bc3350276c1$var$_locale_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $8tj43$babelruntimehelpersclassPrivateFieldGet(this, $eb064bc3350276c1$var$_locale_signal)[1](locale_obj);
   }
   get modal_open() {

package/latest/index.cjs

@@ -92,7 +92,7 @@ $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad99
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
 $parcel$export(module.exports, "SearchField", () => $c0a0659cf97e8eb2$export$316f6f283ae64765);
 /*! Depict.ai search and product listing SDK */
-const $b757f75811f3261f$export$83d89fbfd8236492 = "4.0.27";
+const $b757f75811f3261f$export$83d89fbfd8236492 = "4.1.0";
 const $d84fe647b84b5dc5$export$3064e1e8c6513da3 = new Set();
 let $d84fe647b84b5dc5$var$has_ran = false;
 function $d84fe647b84b5dc5$export$5162a71f252e6122() {
@@ -11712,6 +11712,11 @@ const $48567ac5b39bac56$var$InExternalAreaDiv = ({
   return _el$;
 })();
 class $48567ac5b39bac56$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   #router;
   #localization_signal = $gVhhF$solidjs.createSignal();
   #merchant_signal = $gVhhF$solidjs.createSignal();
@@ -11724,6 +11729,9 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
     return this.#localization_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#localization_signal[1](locale_obj);
   }
   get listing_query() {
@@ -11802,8 +11810,9 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $0785f4c9947d9b5f$export$f091cbac892643a4(this.#localization_signal[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $48567ac5b39bac56$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $gVhhF$solidjs.createSignal(),
         quicklinks_signal_: $gVhhF$solidjs.createSignal(),
         i18n_: i18n_,
@@ -11860,14 +11869,14 @@ function $48567ac5b39bac56$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -13703,6 +13712,9 @@ class $2c61e4cd8229c49a$export$ac6237957a15b3f0 {
     return this.#locale_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#locale_signal[1](locale_obj);
   }
   get modal_open() {

package/latest/index.d.ts

@@ -4,13 +4,13 @@ import { SearchFilter, SearchRequestV3, SortModel } from "@depict-ai/types/api/S
 import { ContentLink, SearchResponse, SearchFilter as _SearchFilter1 } from "@depict-ai/types/api/SearchResponse";
 import { Ancestors, ListingSuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
 import { ProductListing, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
-import { ProductListingResponseV3 } from "@depict-ai/types/api/ProductListingResponseV3";
+import { ProductListingResponseV3, SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/ProductListingResponseV3";
 import { SearchSuggestionsRequestV3 } from "@depict-ai/types/api/SearchSuggestionsRequestV3";
 import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequestV3";
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
-import { SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "4.0.27";
+import { SearchFilter as _SearchFilter3 } from "@depict-ai/types/api/SearchRequestV2";
+export const version = "4.1.0";
 export const prefixes_to_preserve_in_history_dot_state: Set<string>;
 /**
  * Prevent, usually SPAs, from deleting our stuff from history.state when they call history.pushState with a new object they have constructed. This will only run once no matter how often it's called.
@@ -78,12 +78,16 @@ export function createDeparallelizedNoDropResource<T, X>(dependency: Accessor<T
 export function throw_globally<T extends (...args: any) => any>(fn?: T): (...args: Parameters<T>) => ReturnType<T> | undefined;
 declare const LISTING_ID = "listingId";
 declare const EXTERNAL_ID = "externalId";
+type ScrollRestorationData = {
+  min_results_loaded: number;
+  for_id: string;
+}[];
 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 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.
@@ -667,7 +671,7 @@ export type BaseSearchProviderConfig<InputDisplay extends Display, PossibleTrans
   urlParamName?: string;
   /**
    * Whether to enable category suggestions in the search modal and search page.
-   * @default false
+   * @default true
    */
   enableCategorySuggestions?: boolean;
   /**
@@ -1184,6 +1188,27 @@ type CategoryConstructorOptionsWithoutApi<InputDisplay extends Display, OutputDi
 type DepictCategoryConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = CategoryConstructorOptionsWithApi<InputDisplay, OutputDisplay> | CategoryConstructorOptionsWithoutApi<InputDisplay, OutputDisplay>;
 export class DepictCategory<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
+  /**
+   * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+   */
+  historyStateSignals_: {
+    filters_open: Signal<boolean>;
+    sorting_open: Signal<boolean>;
+    expanded_filters: Signal<{
+      section_: string;
+      expanded_: boolean;
+    }[]>;
+    local_filter_cache: Signal<_SearchFilter2[]>;
+    expanded_hierarchical_filters: Signal<{
+      value_: string[];
+      expanded_: boolean;
+    }[]>;
+    scroll_restoration_data: Signal<ScrollRestorationData>;
+  };
+  /**
+   * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+   */
+  selectedFilters_: Signal<FilterWithData[]>;
   get localization(): category_i18n;
   set localization(locale_obj: category_i18n);
   get listing_query(): ListingQuery;
@@ -1301,7 +1326,7 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
   set merchant(tenant: string);
   get market(): string;
   set market(market: string);
-  fetchSearchResults(query: string, filters?: _SearchFilter2[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
+  fetchSearchResults(query: string, filters?: _SearchFilter3[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
 }
 /**
  * This is the SearchPage component visible outside - exported from @depict-ai/ui.

package/latest/index.js

@@ -7,7 +7,7 @@ import { createStore as $9HbP8$createStore, reconcile as $9HbP8$reconcile } from
 /*! 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 = "4.0.27";
+const $ec291e0010116877$export$83d89fbfd8236492 = "4.1.0";
 const $90980bd87c9960f9$export$3064e1e8c6513da3 = new Set();
 let $90980bd87c9960f9$var$has_ran = false;
 function $90980bd87c9960f9$export$5162a71f252e6122() {
@@ -11627,6 +11627,11 @@ const $961b5c64bef4662f$var$InExternalAreaDiv = ({
   return _el$;
 })();
 class $961b5c64bef4662f$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   #router;
   #localization_signal = $9HbP8$createSignal();
   #merchant_signal = $9HbP8$createSignal();
@@ -11639,6 +11644,9 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
     return this.#localization_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#localization_signal[1](locale_obj);
   }
   get listing_query() {
@@ -11717,8 +11725,9 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $c16e74cfe125bb05$export$f091cbac892643a4(this.#localization_signal[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $961b5c64bef4662f$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $9HbP8$createSignal(),
         quicklinks_signal_: $9HbP8$createSignal(),
         i18n_: i18n_,
@@ -11775,14 +11784,14 @@ function $961b5c64bef4662f$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -13618,6 +13627,9 @@ class $806c97b931758897$export$ac6237957a15b3f0 {
     return this.#locale_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#locale_signal[1](locale_obj);
   }
   get modal_open() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@depict-ai/ui",
-  "version": "4.0.27",
+  "version": "4.1.0",
   "description": "Base package containing the actual UI of Depict UI along with translations, with a not-simplified API. We recommend using @depict-ai/js-ui or @depict-ai/react-ui instead.",
   "packageManager": "yarn@3.2.2",
   "sass": "styles.scss",

package/server/ES10/index.cjs

@@ -98,7 +98,7 @@ $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $33eed84f447a
 $parcel$export(module.exports, "version", () => $aa1938dec50d6c12$export$83d89fbfd8236492);
 $parcel$export(module.exports, "SearchField", () => $98aef9965764903d$export$316f6f283ae64765);
 /*! Depict.ai search and product listing SDK */
-const $aa1938dec50d6c12$export$83d89fbfd8236492 = "4.0.27";
+const $aa1938dec50d6c12$export$83d89fbfd8236492 = "4.1.0";
 const $cfcd56242923775d$export$3064e1e8c6513da3 = new Set();
 let $cfcd56242923775d$var$has_ran = false;
 function $cfcd56242923775d$export$5162a71f252e6122() {
@@ -10132,11 +10132,19 @@ var $9cbefc32b9dab36d$var$_market_signal = /*#__PURE__*/new WeakMap();
 var $9cbefc32b9dab36d$var$_listing_query_signal = /*#__PURE__*/new WeakMap();
 var $9cbefc32b9dab36d$var$_disable_override_listing_id = /*#__PURE__*/new WeakMap();
 class $9cbefc32b9dab36d$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   get localization() {
     // allow reactive access
     return $parcel$interopDefault($3hooq$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $parcel$interopDefault($3hooq$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[1](locale_obj);
   }
   get listing_query() {
@@ -10179,6 +10187,8 @@ class $9cbefc32b9dab36d$export$f34314aa9505732e {
       listing_query_state_key: listing_query_state_key,
       ...props_on_class
     } = _ref2;
+    $parcel$interopDefault($3hooq$babelruntimehelpersdefineProperty)(this, "historyStateSignals_", void 0);
+    $parcel$interopDefault($3hooq$babelruntimehelpersdefineProperty)(this, "selectedFilters_", void 0);
     $9cbefc32b9dab36d$var$_classPrivateFieldInitSpec(this, $9cbefc32b9dab36d$var$_router, {
       writable: true,
       value: void 0
@@ -10240,8 +10250,9 @@ class $9cbefc32b9dab36d$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $39cca429fb71d8ff$export$f091cbac892643a4($parcel$interopDefault($3hooq$babelruntimehelpersclassPrivateFieldGet)(this, $9cbefc32b9dab36d$var$_localization_signal)[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $9cbefc32b9dab36d$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $3hooq$solidjs.createSignal(),
         quicklinks_signal_: $3hooq$solidjs.createSignal(),
         i18n_: i18n_,
@@ -10307,14 +10318,14 @@ function $9cbefc32b9dab36d$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -12151,6 +12162,9 @@ class $ddd39c5f36f49703$export$ac6237957a15b3f0 {
     return $parcel$interopDefault($3hooq$babelruntimehelpersclassPrivateFieldGet)(this, $ddd39c5f36f49703$var$_locale_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $parcel$interopDefault($3hooq$babelruntimehelpersclassPrivateFieldGet)(this, $ddd39c5f36f49703$var$_locale_signal)[1](locale_obj);
   }
   get modal_open() {

package/server/ES10/index.d.ts

@@ -4,13 +4,13 @@ import { SearchFilter, SearchRequestV3, SortModel } from "@depict-ai/types/api/S
 import { ContentLink, SearchResponse, SearchFilter as _SearchFilter1 } from "@depict-ai/types/api/SearchResponse";
 import { Ancestors, ListingSuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
 import { ProductListing, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
-import { ProductListingResponseV3 } from "@depict-ai/types/api/ProductListingResponseV3";
+import { ProductListingResponseV3, SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/ProductListingResponseV3";
 import { SearchSuggestionsRequestV3 } from "@depict-ai/types/api/SearchSuggestionsRequestV3";
 import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequestV3";
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
-import { SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "4.0.27";
+import { SearchFilter as _SearchFilter3 } from "@depict-ai/types/api/SearchRequestV2";
+export const version = "4.1.0";
 export const prefixes_to_preserve_in_history_dot_state: Set<string>;
 /**
  * Prevent, usually SPAs, from deleting our stuff from history.state when they call history.pushState with a new object they have constructed. This will only run once no matter how often it's called.
@@ -78,12 +78,16 @@ export function createDeparallelizedNoDropResource<T, X>(dependency: Accessor<T
 export function throw_globally<T extends (...args: any) => any>(fn?: T): (...args: Parameters<T>) => ReturnType<T> | undefined;
 declare const LISTING_ID = "listingId";
 declare const EXTERNAL_ID = "externalId";
+type ScrollRestorationData = {
+  min_results_loaded: number;
+  for_id: string;
+}[];
 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 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.
@@ -667,7 +671,7 @@ export type BaseSearchProviderConfig<InputDisplay extends Display, PossibleTrans
   urlParamName?: string;
   /**
    * Whether to enable category suggestions in the search modal and search page.
-   * @default false
+   * @default true
    */
   enableCategorySuggestions?: boolean;
   /**
@@ -1184,6 +1188,27 @@ type CategoryConstructorOptionsWithoutApi<InputDisplay extends Display, OutputDi
 type DepictCategoryConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = CategoryConstructorOptionsWithApi<InputDisplay, OutputDisplay> | CategoryConstructorOptionsWithoutApi<InputDisplay, OutputDisplay>;
 export class DepictCategory<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
+  /**
+   * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+   */
+  historyStateSignals_: {
+    filters_open: Signal<boolean>;
+    sorting_open: Signal<boolean>;
+    expanded_filters: Signal<{
+      section_: string;
+      expanded_: boolean;
+    }[]>;
+    local_filter_cache: Signal<_SearchFilter2[]>;
+    expanded_hierarchical_filters: Signal<{
+      value_: string[];
+      expanded_: boolean;
+    }[]>;
+    scroll_restoration_data: Signal<ScrollRestorationData>;
+  };
+  /**
+   * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+   */
+  selectedFilters_: Signal<FilterWithData[]>;
   get localization(): category_i18n;
   set localization(locale_obj: category_i18n);
   get listing_query(): ListingQuery;
@@ -1301,7 +1326,7 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
   set merchant(tenant: string);
   get market(): string;
   set market(market: string);
-  fetchSearchResults(query: string, filters?: _SearchFilter2[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
+  fetchSearchResults(query: string, filters?: _SearchFilter3[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
 }
 /**
  * This is the SearchPage component visible outside - exported from @depict-ai/ui.

package/server/ES10/index.js

@@ -10,7 +10,7 @@ import { createStore as $b8hua$createStore, reconcile as $b8hua$reconcile } from
 /*! Depict.ai search and product listing SDK */
 import { register_es_version } from "../../multi_import_deduplicator.mjs";
 register_es_version("ui", "ES10");
-const $8db9a15135765c11$export$83d89fbfd8236492 = "4.0.27";
+const $8db9a15135765c11$export$83d89fbfd8236492 = "4.1.0";
 const $68e6625c8d51f847$export$3064e1e8c6513da3 = new Set();
 let $68e6625c8d51f847$var$has_ran = false;
 function $68e6625c8d51f847$export$5162a71f252e6122() {
@@ -10044,11 +10044,19 @@ var $f5f54892fd0c7d9f$var$_market_signal = /*#__PURE__*/new WeakMap();
 var $f5f54892fd0c7d9f$var$_listing_query_signal = /*#__PURE__*/new WeakMap();
 var $f5f54892fd0c7d9f$var$_disable_override_listing_id = /*#__PURE__*/new WeakMap();
 class $f5f54892fd0c7d9f$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   get localization() {
     // allow reactive access
     return $b8hua$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $b8hua$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[1](locale_obj);
   }
   get listing_query() {
@@ -10091,6 +10099,8 @@ class $f5f54892fd0c7d9f$export$f34314aa9505732e {
       listing_query_state_key: listing_query_state_key,
       ...props_on_class
     } = _ref2;
+    $b8hua$babelruntimehelpersdefineProperty(this, "historyStateSignals_", void 0);
+    $b8hua$babelruntimehelpersdefineProperty(this, "selectedFilters_", void 0);
     $f5f54892fd0c7d9f$var$_classPrivateFieldInitSpec(this, $f5f54892fd0c7d9f$var$_router, {
       writable: true,
       value: void 0
@@ -10152,8 +10162,9 @@ class $f5f54892fd0c7d9f$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $e18ab2868df26f40$export$f091cbac892643a4($b8hua$babelruntimehelpersclassPrivateFieldGet(this, $f5f54892fd0c7d9f$var$_localization_signal)[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $f5f54892fd0c7d9f$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $b8hua$createSignal(),
         quicklinks_signal_: $b8hua$createSignal(),
         i18n_: i18n_,
@@ -10219,14 +10230,14 @@ function $f5f54892fd0c7d9f$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -12063,6 +12074,9 @@ class $eb064bc3350276c1$export$ac6237957a15b3f0 {
     return $b8hua$babelruntimehelpersclassPrivateFieldGet(this, $eb064bc3350276c1$var$_locale_signal)[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     $b8hua$babelruntimehelpersclassPrivateFieldGet(this, $eb064bc3350276c1$var$_locale_signal)[1](locale_obj);
   }
   get modal_open() {

package/server/latest/index.cjs

@@ -92,7 +92,7 @@ $parcel$export(module.exports, "defaultCategoryTitlePlugin", () => $a3280f0aad99
 $parcel$export(module.exports, "version", () => $b757f75811f3261f$export$83d89fbfd8236492);
 $parcel$export(module.exports, "SearchField", () => $c0a0659cf97e8eb2$export$316f6f283ae64765);
 /*! Depict.ai search and product listing SDK */
-const $b757f75811f3261f$export$83d89fbfd8236492 = "4.0.27";
+const $b757f75811f3261f$export$83d89fbfd8236492 = "4.1.0";
 const $d84fe647b84b5dc5$export$3064e1e8c6513da3 = new Set();
 let $d84fe647b84b5dc5$var$has_ran = false;
 function $d84fe647b84b5dc5$export$5162a71f252e6122() {
@@ -9474,6 +9474,11 @@ const $48567ac5b39bac56$var$InExternalAreaDiv = ({
   children: children
 }) => $5vyXB$solidjsweb.ssr($48567ac5b39bac56$var$_tmpl$, $5vyXB$solidjsweb.ssrHydrationKey() + $5vyXB$solidjsweb.ssrAttribute("id", $5vyXB$solidjsweb.escape((0, $0b6e2070a98de347$export$44dad306455dddf).PLP_CATEGORY, true), false), $5vyXB$solidjsweb.escape(children));
 class $48567ac5b39bac56$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   #router;
   #localization_signal = $5vyXB$solidjs.createSignal();
   #merchant_signal = $5vyXB$solidjs.createSignal();
@@ -9486,6 +9491,9 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
     return this.#localization_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#localization_signal[1](locale_obj);
   }
   get listing_query() {
@@ -9564,8 +9572,9 @@ class $48567ac5b39bac56$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $0785f4c9947d9b5f$export$f091cbac892643a4(this.#localization_signal[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $48567ac5b39bac56$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $5vyXB$solidjs.createSignal(),
         quicklinks_signal_: $5vyXB$solidjs.createSignal(),
         i18n_: i18n_,
@@ -9622,14 +9631,14 @@ function $48567ac5b39bac56$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -11307,6 +11316,9 @@ class $2c61e4cd8229c49a$export$ac6237957a15b3f0 {
     return this.#locale_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#locale_signal[1](locale_obj);
   }
   get modal_open() {

package/server/latest/index.d.ts

@@ -4,13 +4,13 @@ import { SearchFilter, SearchRequestV3, SortModel } from "@depict-ai/types/api/S
 import { ContentLink, SearchResponse, SearchFilter as _SearchFilter1 } from "@depict-ai/types/api/SearchResponse";
 import { Ancestors, ListingSuggestion, SearchSuggestionsResponseV3 } from "@depict-ai/types/api/SearchSuggestionsResponseV3";
 import { ProductListing, GetListingResponse } from "@depict-ai/types/api/GetListingResponse";
-import { ProductListingResponseV3 } from "@depict-ai/types/api/ProductListingResponseV3";
+import { ProductListingResponseV3, SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/ProductListingResponseV3";
 import { SearchSuggestionsRequestV3 } from "@depict-ai/types/api/SearchSuggestionsRequestV3";
 import { ProductListingRequestV3 } from "@depict-ai/types/api/ProductListingRequestV3";
 import { GetListingRequest } from "@depict-ai/types/api/GetListingRequest";
 import { BaseSearchRequestV3 } from "@depict-ai/types/api/BaseSearchRequestV3";
-import { SearchFilter as _SearchFilter2 } from "@depict-ai/types/api/SearchRequestV2";
-export const version = "4.0.27";
+import { SearchFilter as _SearchFilter3 } from "@depict-ai/types/api/SearchRequestV2";
+export const version = "4.1.0";
 export const prefixes_to_preserve_in_history_dot_state: Set<string>;
 /**
  * Prevent, usually SPAs, from deleting our stuff from history.state when they call history.pushState with a new object they have constructed. This will only run once no matter how often it's called.
@@ -78,12 +78,16 @@ export function createDeparallelizedNoDropResource<T, X>(dependency: Accessor<T
 export function throw_globally<T extends (...args: any) => any>(fn?: T): (...args: Parameters<T>) => ReturnType<T> | undefined;
 declare const LISTING_ID = "listingId";
 declare const EXTERNAL_ID = "externalId";
+type ScrollRestorationData = {
+  min_results_loaded: number;
+  for_id: string;
+}[];
 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 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.
@@ -667,7 +671,7 @@ export type BaseSearchProviderConfig<InputDisplay extends Display, PossibleTrans
   urlParamName?: string;
   /**
    * Whether to enable category suggestions in the search modal and search page.
-   * @default false
+   * @default true
    */
   enableCategorySuggestions?: boolean;
   /**
@@ -1184,6 +1188,27 @@ type CategoryConstructorOptionsWithoutApi<InputDisplay extends Display, OutputDi
 type DepictCategoryConstructorOptions<InputDisplay extends Display, OutputDisplay extends ModernDisplay> = CategoryConstructorOptionsWithApi<InputDisplay, OutputDisplay> | CategoryConstructorOptionsWithoutApi<InputDisplay, OutputDisplay>;
 export class DepictCategory<InputDisplay extends Display, OutputDisplay extends ModernDisplay | never = InputDisplay extends ModernDisplay ? ModernDisplayWithPageUrl<InputDisplay> : never> {
   #private;
+  /**
+   * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+   */
+  historyStateSignals_: {
+    filters_open: Signal<boolean>;
+    sorting_open: Signal<boolean>;
+    expanded_filters: Signal<{
+      section_: string;
+      expanded_: boolean;
+    }[]>;
+    local_filter_cache: Signal<_SearchFilter2[]>;
+    expanded_hierarchical_filters: Signal<{
+      value_: string[];
+      expanded_: boolean;
+    }[]>;
+    scroll_restoration_data: Signal<ScrollRestorationData>;
+  };
+  /**
+   * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+   */
+  selectedFilters_: Signal<FilterWithData[]>;
   get localization(): category_i18n;
   set localization(locale_obj: category_i18n);
   get listing_query(): ListingQuery;
@@ -1301,7 +1326,7 @@ export class DepictSearch<InputDisplay extends Display, OutputDisplay extends Mo
   set merchant(tenant: string);
   get market(): string;
   set market(market: string);
-  fetchSearchResults(query: string, filters?: _SearchFilter2[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
+  fetchSearchResults(query: string, filters?: _SearchFilter3[], maxResults?: number): Promise<([OutputDisplay] extends [never] ? InputDisplay : ModernDisplayWithPageUrl<OutputDisplay>)[]>;
 }
 /**
  * This is the SearchPage component visible outside - exported from @depict-ai/ui.

package/server/latest/index.js

@@ -7,7 +7,7 @@ import { createStore as $i7OB2$createStore, reconcile as $i7OB2$reconcile } from
 /*! 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 = "4.0.27";
+const $ec291e0010116877$export$83d89fbfd8236492 = "4.1.0";
 const $90980bd87c9960f9$export$3064e1e8c6513da3 = new Set();
 let $90980bd87c9960f9$var$has_ran = false;
 function $90980bd87c9960f9$export$5162a71f252e6122() {
@@ -9389,6 +9389,11 @@ const $961b5c64bef4662f$var$InExternalAreaDiv = ({
   children: children
 }) => $i7OB2$ssr($961b5c64bef4662f$var$_tmpl$, $i7OB2$ssrHydrationKey() + $i7OB2$ssrAttribute("id", $i7OB2$escape((0, $f86ba724282f6690$export$44dad306455dddf).PLP_CATEGORY, true), false), $i7OB2$escape(children));
 class $961b5c64bef4662f$export$f34314aa9505732e {
+  /**
+  * Used internally in @depict-ai/react-ui for `useCategoryFilterHelpers`. These are solid-js signals that contain the value of the state for this DepictCategory instance that's currently in history.state. Calling the setters updates history.state with history.replaceState.
+  */ /**
+     * Signal representing the currently selected filters. Will update to always reflect the state of the current URL. Calling the setter triggers a navigation (replaceState) to an updated URL.
+     */
   #router;
   #localization_signal = $i7OB2$createSignal();
   #merchant_signal = $i7OB2$createSignal();
@@ -9401,6 +9406,9 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
     return this.#localization_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#localization_signal[1](locale_obj);
   }
   get listing_query() {
@@ -9479,8 +9487,9 @@ class $961b5c64bef4662f$export$f34314aa9505732e {
         prefix_: "category" + unique_instance_key_for_state + "_"
       });
       const i18n_ = $c16e74cfe125bb05$export$f091cbac892643a4(this.#localization_signal[0]);
+      this.historyStateSignals_ = state_;
+      this.selectedFilters_ = selected_filters_;
       $961b5c64bef4662f$var$privately_shared_properties.set(this, {
-        state_: state_,
         breadcrumb_signal_: $i7OB2$createSignal(),
         quicklinks_signal_: $i7OB2$createSignal(),
         i18n_: i18n_,
@@ -9537,14 +9546,14 @@ function $961b5c64bef4662f$export$e2bf8ce7779e827e(props) {
       };
     });
     const {
-      state_: {
-        local_filter_cache: local_filter_cache_,
-        filters_open: category_filters_open_,
-        sorting_open: category_sorting_open_,
-        expanded_filters: expanded_filters_,
-        expanded_hierarchical_filters: expanded_hierarchical_filters_,
-        scroll_restoration_data: scroll_restoration_data_
-      },
+      local_filter_cache: local_filter_cache_,
+      filters_open: category_filters_open_,
+      sorting_open: category_sorting_open_,
+      expanded_filters: expanded_filters_,
+      expanded_hierarchical_filters: expanded_hierarchical_filters_,
+      scroll_restoration_data: scroll_restoration_data_
+    } = depict_category.historyStateSignals_;
+    const {
       current_sorting_: current_sorting_,
       selected_filters_: selected_filters_,
       override_listing_id_accessor_: override_listing_id_accessor_,
@@ -11222,6 +11231,9 @@ class $806c97b931758897$export$ac6237957a15b3f0 {
     return this.#locale_signal[0]();
   }
   set localization(locale_obj) {
+    if (typeof locale_obj === "string")
+      // Prevent people not using typescript from accidentally passing a string instead of an object, see https://depictaiworkspace.slack.com/archives/C04RF3KTK0A/p1707211551951239
+      throw new Error("locale must be an object, see the TypeScript definitions");
     this.#locale_signal[1](locale_obj);
   }
   get modal_open() {