@coveo/quantic 3.24.0 → 3.24.1-pre.153636d7cb

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/category-facet/category-facet-actions.d.ts

@@ -1,5 +1,12 @@
-import { ToggleSelectCategoryFacetValueActionCreatorPayload, UpdateCategoryFacetNumberOfValuesActionCreatorPayload } from '../../../facets/category-facet-set/category-facet-set-actions.js';
+import type { ToggleSelectCategoryFacetValueActionCreatorPayload, UpdateCategoryFacetNumberOfValuesActionCreatorPayload } from '../../../facets/category-facet-set/category-facet-set-actions.js';
 export type UpdateCategoryFacetNumberOfValuesPayload = UpdateCategoryFacetNumberOfValuesActionCreatorPayload;
 export declare const updateCategoryFacetNumberOfValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateCategoryFacetNumberOfValuesActionCreatorPayload], UpdateCategoryFacetNumberOfValuesActionCreatorPayload, "commerce/facets/categoryFacet/updateNumberOfValues", never, never>;
-export type ToggleSelectCategoryFacetValuePayload = ToggleSelectCategoryFacetValueActionCreatorPayload;
-export declare const toggleSelectCategoryFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectCategoryFacetValueActionCreatorPayload], ToggleSelectCategoryFacetValueActionCreatorPayload, "commerce/facets/categoryFacet/toggleSelectValue", import("@reduxjs/toolkit").SerializedError | null, never>;
+export type ToggleSelectCategoryFacetValuePayload = Omit<ToggleSelectCategoryFacetValueActionCreatorPayload, 'retrieveCount'> & {
+    /**
+     * The number of child values to display.
+     *
+     * @deprecated This property is no longer used in the commerce category facet and will be removed in the next major version of headless.
+     */
+    retrieveCount?: number;
+};
+export declare const toggleSelectCategoryFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectCategoryFacetValuePayload], ToggleSelectCategoryFacetValuePayload, "commerce/facets/categoryFacet/toggleSelectValue", import("@reduxjs/toolkit").SerializedError | null, never>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/facet-set-reducers.d.ts

@@ -1,6 +1,6 @@
-import { Parameters } from '../../parameters/parameters-actions.js';
-import { CommerceFacetSetState } from './facet-set-state.js';
-import { CategoryFacetRequest, CategoryFacetValueRequest } from './interfaces/request.js';
+import type { Parameters } from '../../parameters/parameters-actions.js';
+import type { CommerceFacetSetState } from './facet-set-state.js';
+import type { CategoryFacetRequest, CategoryFacetValueRequest } from './interfaces/request.js';
 export declare function restoreFromParameters(state: CommerceFacetSetState, action: {
     payload: Parameters;
 }): void;
@@ -8,6 +8,6 @@ export declare function buildSelectedFacetValueRequest(rawValue: string): {
     state: string;
     value: string;
 };
-export declare function selectPath(request: CategoryFacetRequest, path: string[], initialNumberOfValues: number): void;
-export declare function buildCurrentValuesFromPath(path: string[], retrieveCount: number): CategoryFacetValueRequest[];
-export declare function buildCategoryFacetValueRequest(value: string, retrieveCount: number): CategoryFacetValueRequest;
+export declare function selectPath(request: CategoryFacetRequest, path: string[], initialNumberOfValues?: number): void;
+export declare function buildCurrentValuesFromPath(path: string[]): CategoryFacetValueRequest[];
+export declare function buildCategoryFacetValueRequest(value: string): CategoryFacetValueRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/facet-set-slice.d.ts

@@ -1,8 +1,7 @@
-import { CategoryFacetValueRequest } from '../../../../controllers/commerce/core/facets/headless-core-commerce-facet.js';
-import '../category-facet/category-facet-actions.js';
-import { CommerceFacetSetState } from './facet-set-state.js';
-import { LocationFacetValueRequest } from './interfaces/request.js';
-import { CategoryFacetValue, LocationFacetValue } from './interfaces/response.js';
+import type { CategoryFacetValueRequest } from '../../../../controllers/commerce/core/facets/headless-core-commerce-facet.js';
+import { type CommerceFacetSetState } from './facet-set-state.js';
+import type { LocationFacetValueRequest } from './interfaces/request.js';
+import type { CategoryFacetValue, LocationFacetValue } from './interfaces/response.js';
 export declare const commerceFacetSetReducer: import("redux").Reducer<CommerceFacetSetState> & {
     getInitialState: () => CommerceFacetSetState;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/interfaces/request.d.ts

@@ -6,11 +6,12 @@ export type FreezableFacetRequestProperties = {
     preventAutoSelect: boolean;
     freezeCurrentValues?: boolean;
 };
-export type CategoryFacetRequest = BaseCommerceFacetRequest<CategoryFacetValueRequest, 'hierarchical'> & CategoryFacetDelimitingCharacter & FreezableFacetRequestProperties;
+export type CategoryFacetRequest = BaseCommerceFacetRequest<CategoryFacetValueRequest, 'hierarchical'> & CategoryFacetDelimitingCharacter & FreezableFacetRequestProperties & {
+    retrieveCount?: number;
+};
 export interface CategoryFacetValueRequest extends BaseFacetValueRequest {
     children: CategoryFacetValueRequest[];
     value: string;
-    retrieveCount?: number;
 }
 export type DateFacetRequest = BaseCommerceFacetRequest<DateRangeRequest, 'dateRange'> & FreezableFacetRequestProperties;
 export type NumericFacetRequest = BaseCommerceFacetRequest<NumericRangeRequest, 'numericalRange'> & NumericFacetExtraProperties & FreezableFacetRequestProperties;
@@ -21,7 +22,7 @@ export type BaseCommerceFacetRequest<Value, Type extends FacetType> = Pick<Facet
     displayName?: string;
     type: Type;
     values: Value[];
-    initialNumberOfValues: number;
+    initialNumberOfValues?: number;
     numberOfValues?: number;
 };
 export type AnyFacetValueRequest = FacetValueRequest | LocationFacetValueRequest | CategoryFacetValueRequest | NumericRangeRequest | DateRangeRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/interfaces/response.d.ts

@@ -1,5 +1,18 @@
 import { BaseFacetResponse } from '../../../facet-api/response.js';
 import { FacetValueState } from '../../../facet-api/value.js';
+/**
+ * The domain of a date facet.
+ */
+export interface DateFacetDomain {
+    /**
+     * The most recent date available value in the range.
+     */
+    end: string;
+    /**
+     * The least recent date available value in the range.
+     */
+    start: string;
+}
 export interface DateFacetValue {
     /**
      * The number of results that have the facet value.
@@ -22,4 +35,6 @@ export interface DateFacetValue {
      */
     state: FacetValueState;
 }
-export type DateFacetResponse = BaseFacetResponse<DateFacetValue>;
+export type DateFacetResponse = BaseFacetResponse<DateFacetValue> & {
+    domain: DateFacetDomain;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/interfaces/response.d.ts

@@ -1,5 +1,18 @@
 import { BaseFacetResponse } from '../../../facet-api/response.js';
 import { FacetValueState } from '../../../facet-api/value.js';
+/**
+ * The domain of a numeric facet.
+ */
+export interface NumericFacetDomain {
+    /**
+     * The largest available value in the range.
+     */
+    end: number;
+    /**
+     * The smallest available value in the range.
+     */
+    start: number;
+}
 export interface NumericFacetValue {
     /**
      * The number of results that have the facet value.
@@ -22,4 +35,6 @@ export interface NumericFacetValue {
      */
     state: FacetValueState;
 }
-export type NumericFacetResponse = BaseFacetResponse<NumericFacetValue>;
+export type NumericFacetResponse = BaseFacetResponse<NumericFacetValue> & {
+    domain: NumericFacetDomain;
+};