@coveo/quantic 3.43.4 → 3.43.6

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts

@@ -1,6 +1,9 @@
 import type { BaseParam } from '../../../platform-service-params.js';
 import type { ClientIdParam, ContextParam, CountryParam, CurrencyParam, LanguageParam, QueryParam, TrackingIdParam } from '../../commerce-api-params.js';
-export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam;
+interface CountParam {
+    count?: number;
+}
+export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam & CountParam;
 export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) => {
     requestParams: {
         trackingId: string;
@@ -21,6 +24,7 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         language: string;
         country: string;
         currency: string;
+        count: number | undefined;
     };
     accessToken: string;
     url: string;
@@ -29,3 +33,4 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search-box/headless-search-box-options.d.ts

@@ -1,6 +1,12 @@
-import { BooleanValue, Schema } from '@coveo/bueno';
+import { BooleanValue, NumberValue, Schema } from '@coveo/bueno';
 import { type SearchBoxOptions as CoreSearchBoxOptions } from '../../core/search-box/headless-core-search-box-options.js';
 export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptions' | 'clearFilters'> & {
+    /**
+     * The number of query suggestions to request from the Coveo ML model (for example, `3`).
+     *
+     * When not specified, the API determines the number of suggestions returned.
+     */
+    numberOfSuggestions?: number;
     /**
      * When set to true, fills the `results` field rather than the `products` field
      * in the response. It may also include Spotlight Content in the results.
@@ -10,10 +16,12 @@ export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptio
 };
 type DefaultSearchBoxOptions = Pick<SearchBoxOptions, 'clearFilters' | 'enableResults'>;
 export declare const defaultSearchBoxOptions: Required<DefaultSearchBoxOptions>;
+export type ResolvedSearchBoxOptions = Required<Omit<SearchBoxOptions, 'numberOfSuggestions'>> & Pick<SearchBoxOptions, 'numberOfSuggestions'>;
 export declare const searchBoxOptionDefinitions: {
     id: import("@coveo/bueno").StringValue<string>;
     highlightOptions: import("@coveo/bueno").RecordValue;
     clearFilters: BooleanValue;
+    numberOfSuggestions: NumberValue;
     enableResults: BooleanValue;
 };
 export declare const searchBoxOptionsSchema: Schema<Required<SearchBoxOptions>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/standalone-search-box/headless-standalone-search-box-options.d.ts

@@ -11,4 +11,5 @@ export interface StandaloneSearchBoxOptions extends SearchBoxOptions {
      */
     overwrite?: boolean;
 }
+export type ResolvedStandaloneSearchBoxOptions = Required<Omit<StandaloneSearchBoxOptions, 'numberOfSuggestions'>> & Pick<StandaloneSearchBoxOptions, 'numberOfSuggestions'>;
 export declare const standaloneSearchBoxSchema: Schema<Required<StandaloneSearchBoxOptions>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/commerce-query-suggest-slice.d.ts

@@ -1,3 +1,4 @@
-export declare const commerceQuerySuggestReducer: import("@reduxjs/toolkit").Reducer<import("../../query-suggest/query-suggest-state.js").QuerySuggestSet> & {
-    getInitialState: () => import("../../query-suggest/query-suggest-state.js").QuerySuggestSet;
+import { type QuerySuggestSet } from '../../query-suggest/query-suggest-state.js';
+export declare const commerceQuerySuggestReducer: import("@reduxjs/toolkit").Reducer<QuerySuggestSet> & {
+    getInitialState: () => QuerySuggestSet;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/query-suggest-actions.d.ts

@@ -1,10 +1,10 @@
 import type { QuerySuggestSuccessResponse } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
-import type { CartSection, CommerceConfigurationSection, CommerceContextSection, CommerceQuerySection, QuerySetSection, VersionSection } from '../../../state/state-sections.js';
-import type { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, RegisterQuerySuggestActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
+import type { CartSection, CommerceConfigurationSection, CommerceContextSection, CommerceQuerySection, QuerySetSection, QuerySuggestionSection, VersionSection } from '../../../state/state-sections.js';
+import type { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
 export type ClearQuerySuggestPayload = ClearQuerySuggestActionCreatorPayload;
 export declare const clearQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ClearQuerySuggestActionCreatorPayload], ClearQuerySuggestActionCreatorPayload, "commerce/querySuggest/clear", never, never>;
 export type FetchQuerySuggestionsPayload = FetchQuerySuggestionsActionCreatorPayload;
-export type StateNeededByQuerySuggest = CommerceConfigurationSection & CommerceContextSection & CartSection & QuerySetSection & CommerceQuerySection & Partial<VersionSection>;
+export type StateNeededByQuerySuggest = CommerceConfigurationSection & CommerceContextSection & CartSection & QuerySetSection & CommerceQuerySection & Partial<QuerySuggestionSection & VersionSection>;
 export interface FetchQuerySuggestionsThunkReturn extends FetchQuerySuggestionsActionCreatorPayload, QuerySuggestSuccessResponse {
     /**
      * The query for which query suggestions were retrieved.
@@ -21,7 +21,18 @@ export declare const fetchQuerySuggestions: import("@reduxjs/toolkit").AsyncThun
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-export type RegisterQuerySuggestPayload = RegisterQuerySuggestActionCreatorPayload;
-export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestActionCreatorPayload], RegisterQuerySuggestActionCreatorPayload, "commerce/querySuggest/register", never, never>;
+export interface RegisterQuerySuggestPayload {
+    /**
+     * A unique identifier for the query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
+     */
+    id: string;
+    /**
+     * The number of query suggestions to request from the API.
+     *
+     * When not specified, the API determines the default number of suggestions returned.
+     */
+    count?: number;
+}
+export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestPayload], RegisterQuerySuggestPayload, "commerce/querySuggest/register", never, never>;
 export type SelectQuerySuggestionPayload = SelectQuerySuggestionActionCreatorPayload;
 export declare const selectQuerySuggestion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SelectQuerySuggestionActionCreatorPayload], SelectQuerySuggestionActionCreatorPayload, "commerce/querySuggest/selectSuggestion", never, never>;