instantsearch.js 4.37.0 → 4.38.0

package/dist/instantsearch.production.d.ts

@@ -1098,9 +1098,9 @@ declare type DynamicWidgetsConnectorParams = {
      * Function to transform the items to render.
      * The function also exposes the full search response.
      */
-    transformItems?(items: string[], metadata: {
-        results: SearchResults;
-    }): string[];
+    transformItems?: TransformItems<string, Omit<TransformItemsMetadata, 'results'> & {
+        results: NonNullable<TransformItemsMetadata['results']>;
+    }>;
     /**
      * To prevent unneeded extra network requests when widgets mount or unmount,
      * we request all facet values.
@@ -3203,8 +3203,6 @@ declare type ParamTrackedFilters = {
     [facetName: string]: (facetValues: TrackedFilterRefinement[]) => TrackedFilterRefinement[];
 };
 
-declare type ParamTransformItems = TransformItems<any>;
-
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
 declare type ParseURL<TRouteState> = (args: {
@@ -3345,7 +3343,7 @@ declare type QueryRulesConnector = Connector<QueryRulesWidgetDescription, QueryR
 declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 
 declare type QueryRulesRenderState = {
@@ -4915,7 +4913,9 @@ declare const toggleRefinement: ToggleRefinementWidget;
 declare type ToggleRefinementConnector = Connector<ToggleRefinementWidgetDescription, ToggleRefinementConnectorParams>;
 
 declare type ToggleRefinementConnectorParams = {
-    /** Name of the attribute for faceting (eg. "free_shipping"). */
+    /**
+     * Name of the attribute for faceting (e.g., "free_shipping").
+     */
     attribute: string;
     /**
      * Value to filter on when toggled.
@@ -4950,19 +4950,42 @@ declare type ToggleRefinementCSSClasses = Partial<{
 declare type ToggleRefinementRenderState = {
     /** The current toggle value */
     value: {
+        /**
+         * The attribute name of this toggle.
+         */
         name: string;
+        /**
+         * Whether the current option is "on" (true) or "off" (false)
+         */
         isRefined: boolean;
+        /**
+         * Number of results if this option is toggled.
+         */
         count: number | null;
+        /**
+         * Information about the "on" toggle.
+         */
         onFacetValue: ToggleRefinementValue;
+        /**
+         * Information about the "off" toggle.
+         */
         offFacetValue: ToggleRefinementValue;
     };
-    /** Creates an URL for the next state. */
+    /**
+     * Creates an URL for the next state.
+     */
     createURL: CreateURL<string>;
-    /** send a "facet clicked" insights event */
+    /**
+     * Send a "Facet Clicked" Insights event.
+     */
     sendEvent: SendEventForToggle;
-    /** Indicates if search state can be refined. */
+    /**
+     * Indicates if search state can be refined.
+     */
     canRefine: boolean;
-    /** Updates to the next state by applying the toggle refinement. */
+    /**
+     * Updates to the next state by applying the toggle refinement.
+     */
     refine: (value?: {
         isRefined: boolean;
     }) => void;
@@ -4976,9 +4999,13 @@ declare type ToggleRefinementTemplates = Partial<{
 }>;
 
 declare type ToggleRefinementValue = {
-    /** whether this option is enabled */
+    /**
+     * Whether this option is enabled.
+     */
     isRefined: boolean;
-    /** number of result if this option is enabled */
+    /**
+     * Number of result if this option is toggled.
+     */
     count: number | null;
 };
 
@@ -5021,7 +5048,11 @@ declare type TrackedFilterRefinement = string | number | boolean;
 /**
  * Transforms the given items.
  */
-declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+
+declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 
 declare type TransformSearchParameters = (searchParameters: SearchParameters) => PlainSearchParameters;
 

package/dist/instantsearch.production.min.d.ts

@@ -1098,9 +1098,9 @@ declare type DynamicWidgetsConnectorParams = {
      * Function to transform the items to render.
      * The function also exposes the full search response.
      */
-    transformItems?(items: string[], metadata: {
-        results: SearchResults;
-    }): string[];
+    transformItems?: TransformItems<string, Omit<TransformItemsMetadata, 'results'> & {
+        results: NonNullable<TransformItemsMetadata['results']>;
+    }>;
     /**
      * To prevent unneeded extra network requests when widgets mount or unmount,
      * we request all facet values.
@@ -3203,8 +3203,6 @@ declare type ParamTrackedFilters = {
     [facetName: string]: (facetValues: TrackedFilterRefinement[]) => TrackedFilterRefinement[];
 };
 
-declare type ParamTransformItems = TransformItems<any>;
-
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
 declare type ParseURL<TRouteState> = (args: {
@@ -3345,7 +3343,7 @@ declare type QueryRulesConnector = Connector<QueryRulesWidgetDescription, QueryR
 declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 
 declare type QueryRulesRenderState = {
@@ -4915,7 +4913,9 @@ declare const toggleRefinement: ToggleRefinementWidget;
 declare type ToggleRefinementConnector = Connector<ToggleRefinementWidgetDescription, ToggleRefinementConnectorParams>;
 
 declare type ToggleRefinementConnectorParams = {
-    /** Name of the attribute for faceting (eg. "free_shipping"). */
+    /**
+     * Name of the attribute for faceting (e.g., "free_shipping").
+     */
     attribute: string;
     /**
      * Value to filter on when toggled.
@@ -4950,19 +4950,42 @@ declare type ToggleRefinementCSSClasses = Partial<{
 declare type ToggleRefinementRenderState = {
     /** The current toggle value */
     value: {
+        /**
+         * The attribute name of this toggle.
+         */
         name: string;
+        /**
+         * Whether the current option is "on" (true) or "off" (false)
+         */
         isRefined: boolean;
+        /**
+         * Number of results if this option is toggled.
+         */
         count: number | null;
+        /**
+         * Information about the "on" toggle.
+         */
         onFacetValue: ToggleRefinementValue;
+        /**
+         * Information about the "off" toggle.
+         */
         offFacetValue: ToggleRefinementValue;
     };
-    /** Creates an URL for the next state. */
+    /**
+     * Creates an URL for the next state.
+     */
     createURL: CreateURL<string>;
-    /** send a "facet clicked" insights event */
+    /**
+     * Send a "Facet Clicked" Insights event.
+     */
     sendEvent: SendEventForToggle;
-    /** Indicates if search state can be refined. */
+    /**
+     * Indicates if search state can be refined.
+     */
     canRefine: boolean;
-    /** Updates to the next state by applying the toggle refinement. */
+    /**
+     * Updates to the next state by applying the toggle refinement.
+     */
     refine: (value?: {
         isRefined: boolean;
     }) => void;
@@ -4976,9 +4999,13 @@ declare type ToggleRefinementTemplates = Partial<{
 }>;
 
 declare type ToggleRefinementValue = {
-    /** whether this option is enabled */
+    /**
+     * Whether this option is enabled.
+     */
     isRefined: boolean;
-    /** number of result if this option is enabled */
+    /**
+     * Number of result if this option is toggled.
+     */
     count: number | null;
 };
 
@@ -5021,7 +5048,11 @@ declare type TrackedFilterRefinement = string | number | boolean;
 /**
  * Transforms the given items.
  */
-declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+
+declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 
 declare type TransformSearchParameters = (searchParameters: SearchParameters) => PlainSearchParameters;