@coveo/quantic 3.29.0-pre.fccbdc0bca → 3.29.0

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts

@@ -15,7 +15,7 @@ export interface ResultsPerPageInitialState {
 /**
  * The `ResultsPerPage` controller allows the end user to choose how many results to display per page.
  *
- * Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/results-per-page/results-per-page.fn.tsx)
+ * Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/results-per-page/results-per-page.fn.tsx)
  *
  * @group Controllers
  * @category ResultsPerPage

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts

@@ -16,7 +16,7 @@ export interface SortInitialState {
 /**
  * The `Sort` controller manages how the results are sorted.
  *
- * Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/sort/sort.fn.tsx)
+ * Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/sort/sort.fn.tsx)
  *
  * @group Controllers
  * @category Sort

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/status/headless-core-status.d.ts

@@ -3,7 +3,7 @@ import { type Controller } from '../../controller/headless-controller.js';
 /**
  * The `SearchStatus` controller lets you access search status information.
  *
- * Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/search-status/search-status.fn.tsx)
+ * Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/search-status/search-status.fn.tsx)
  *
  * @group Controllers
  * @category SearchStatus

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/tab/headless-core-tab.d.ts

@@ -38,7 +38,7 @@ export interface TabProps {
 /**
  * The `Tab` headless controller offers a high-level interface for designing a common tab UI controller.
  *
- * Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/tab/tab.fn.tsx)
+ * Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/tab/tab.fn.tsx)
  *
  * @group Controllers
  * @category Tab

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts

@@ -4,7 +4,7 @@ import { type Controller } from '../../controller/headless-controller.js';
 /**
  * The `NotifyTrigger` controller handles notify triggers. A [Notify trigger](https://docs.coveo.com/en/3413#notify) query pipeline rule lets you define a message to be displayed to the end user when a certain condition is met.
  *
- * Example: [notify-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/triggers/notify-trigger.fn.tsx)
+ * Example: [notify-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/notify-trigger.fn.tsx)
  *
  * @group Controllers
  * @category NotifyTrigger

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-query-trigger.d.ts

@@ -2,7 +2,7 @@ import type { Controller } from '../../controller/headless-controller.js';
 /**
  * The `QueryTrigger` controller handles [query trigger](https://docs.coveo.com/en/3413#query) query pipeline rules, which let you define a search query to execute when a certain condition is met.
  *
- * Example: [query-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/triggers/query-trigger.fn.tsx)
+ * Example: [query-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/query-trigger.fn.tsx)
  *
  * @group Controllers
  * @category QueryTrigger

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts

@@ -2,7 +2,7 @@ import type { Controller } from '../../controller/headless-controller.js';
 /**
  * The `RedirectionTrigger` controller handles redirection triggers. A [Redirection trigger](https://docs.coveo.com/en/3413#redirect) query pipeline rule lets you define a URL to redirect the user's browser to when a certain condition is met.
  *
- * Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/triggers/redirection-trigger.fn.tsx)
+ * Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/redirection-trigger.fn.tsx)
  *
  * @group Controllers
  * @category RedirectionTrigger

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts

@@ -5,7 +5,7 @@ export type { DictionaryFieldContextPayload };
 /**
  * The `DictionaryFieldContext` controller allows specifying which [dictionary field](https://docs.coveo.com/en/2036/) keys to retrieve.
  *
- * Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
+ * Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
  *
  * @group Controllers
  * @category DictionaryFieldContext

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/document-suggestion-list/case-assist-headless-interactive-result.d.ts

@@ -18,8 +18,8 @@ export interface CaseAssistInteractiveResultProps extends InteractiveResultCoreP
  * The `CaseAssistInteractiveResult` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user selects a query result.
  *
  * For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
- * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
- * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
+ * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
+ * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
  *
  * @group Controllers
  * @category CaseAssistInteractiveResult

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/document-suggestion-list/headless-document-suggestion-list.d.ts

@@ -6,8 +6,8 @@ import { type Controller } from '../controller/headless-controller.js';
  * The `DocumentSuggestion` controller is responsible for getting document suggestions using case information present in the state.
  *
  * For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
- * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
- * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
+ * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
+ * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
  *
  * @group Controllers
  * @category DocumentSuggestionList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.d.ts

@@ -12,8 +12,8 @@ export type { AutomaticFacetGeneratorOptions };
  * To learn more about the automatic facet generator feature, see: [About the Facet Generator](https://docs.coveo.com/en/n9sd0159/).
  *
  * Examples:
- * - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
- * - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
+ * - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
+ * - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
  *
  * @group Controllers
  * @category AutomaticFacetGenerator

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts

@@ -54,7 +54,7 @@ export interface CategoryFieldSuggestionsState {
  *
  * This controller is a wrapper around the basic category facet controller search functionality, and thus exposes similar options and properties.
  *
- * Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
+ * Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
  *
  * @group Controllers
  * @category CategoryFieldSuggestions

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts

@@ -47,7 +47,7 @@ export interface FieldSuggestionsState {
  *
  * This controller is a wrapper around the basic facet controller search functionality, and thus exposes similar options and properties.
  *
- * Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/field-suggestions/specific-field/field-suggestions.fn.tsx)
+ * Example: [field-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/field-suggestions/specific-field/field-suggestions.fn.tsx)
  *
  * @group Controllers
  * @category FieldSuggestions

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/history-manager/headless-history-manager.d.ts

@@ -5,7 +5,7 @@ import { type Controller } from '../controller/headless-controller.js';
 /**
  * The `HistoryManager` controller is in charge of allowing navigating back and forward in the search interface history.
  *
- * Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/history-manager/history-manager.fn.tsx)
+ * Example: [history-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/history-manager/history-manager.fn.tsx)
  *
  * @group Controllers
  * @category HistoryManager

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results.d.ts

@@ -11,7 +11,7 @@ export interface InstantResultProps {
 /**
  * The `InstantResults` controller allows the end user to manage instant results queries.
  *
- * Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/instant-results/instant-results.fn.tsx)
+ * Example: [instant-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/instant-results/instant-results.fn.tsx)
  *
  * @group Controllers
  * @category InstantResults

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.d.ts

@@ -7,7 +7,7 @@ export type { QuerySummary, QuerySummaryState };
  * @param engine - The headless engine instance.
  * @returns A `QuerySummary` controller instance.
  *
- * Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/query-summary/query-summary.fn.tsx)
+ * Example: [query-summary.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/query-summary/query-summary.fn.tsx)
  *
  * @group Controllers
  * @category QuerySummary

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/case-assist-headless-quickview.d.ts

@@ -8,8 +8,8 @@ export interface CaseAssistQuickviewOptions extends QuickviewOptions {
  * The `CaseAssistQuickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview.
  *
  * For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/):
- * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
- * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/master/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
+ * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js)
+ * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js)
  *
  * @group Controllers
  * @category CaseAssistQuickview

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts

@@ -24,7 +24,7 @@ export interface QuickviewState extends CoreQuickviewState {
 /**
  * The `Quickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview.
  *
- * Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/quickview/quickview.fn.tsx)
+ * Example: [quickview.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/quickview/quickview.fn.tsx)
  *
  * @group Controllers
  * @category Quickview

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts

@@ -32,7 +32,7 @@ export interface RecentQueriesListOptions {
 /**
  * The `RecentQueriesList` controller manages the user's recent queries.
  *
- * Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/recent-queries/recent-queries.fn.tsx)
+ * Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-queries/recent-queries.fn.tsx)
  *
  * @group Controllers
  * @category RecentQueriesList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts

@@ -28,7 +28,7 @@ export interface RecentResultsListOptions {
 /**
  * The `RecentResultsList` controller manages a user's recently clicked results.
  *
- * Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/recent-results/recent-results.fn.tsx)
+ * Example: [recent-results.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recent-results/recent-results.fn.tsx)
  *
  * @group Controllers
  * @category RecentResultsList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/headless-recommendation.d.ts

@@ -20,7 +20,7 @@ export interface RecommendationListProps {
 /**
  * The `RecommendationList` controller retrieves information about the current recommendations by the search API, if there are any.
  *
- * Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/recommendation-list/recommendation-list.fn.tsx)
+ * Example: [recommendation-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/recommendation-list/recommendation-list.fn.tsx)
  *
  * @group Controllers
  * @category RecommendationList

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts

@@ -22,7 +22,7 @@ export interface RelevanceInspectorInitialState {
 /**
  * The `RelevanceInspector` controller is in charge of allowing displaying various debug information.
  *
- * Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/relevance-inspector/relevance-inspector.fn.tsx)
+ * Example: [relevance-inspector.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/relevance-inspector/relevance-inspector.fn.tsx)
  *
  * @group Controllers
  * @category RelevanceInspector

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-interactive-result.d.ts

@@ -16,7 +16,7 @@ export interface InteractiveResultProps extends InteractiveResultCoreProps {
 /**
  * The `InteractiveResult` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user selects a query result.
  *
- * Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/result-list/result-link.tsx)
+ * Example: [result-link.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/result-list/result-link.tsx)
  *
  * @group Controllers
  * @category InteractiveResult

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts

@@ -13,7 +13,7 @@ export interface SmartSnippetQuestionsListState extends CoreSmartSnippetQuestion
 /**
  * The `SmartSnippetQuestionsList` controller allows to manage additional queries for which a SmartSnippet model can provide relevant excerpts.
  *
- * Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/smart-snippet-questions-list/smart-snippet-questions-list.fn.tsx)
+ * Example: [smart-snippet-questions-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/smart-snippet-questions-list/smart-snippet-questions-list.fn.tsx)
  *
  * @group Controllers
  * @category SmartSnippetQuestionsList

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

@@ -10,7 +10,7 @@ export interface StandaloneSearchBoxProps {
  * The `StandaloneSearchBox` headless controller offers a high-level interface for designing a common search box UI controller.
  * Meant to be used for a search box that will redirect instead of executing a query.
  *
- * Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/standalone-search-box/standalone-search-box.fn.tsx)
+ * Example: [standalone-search-box.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/standalone-search-box/standalone-search-box.fn.tsx)
  *
  * @group Controllers
  * @category StandaloneSearchBox

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts

@@ -23,7 +23,7 @@ export interface StaticFilterOptions {
 /**
  * The `StaticFilter` controller manages a collection of filter values.
  *
- * Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/static-filter/static-filter.fn.tsx)
+ * Example: [static-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/static-filter/static-filter.fn.tsx)
  *
  * @group Controllers
  * @category StaticFilter

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.d.ts

@@ -5,8 +5,8 @@ import { type Controller } from '../controller/headless-controller.js';
  * The `ExecuteTrigger` controller handles Execute triggers from the query response. An [Execute trigger](https://docs.coveo.com/en/3413#execute) query pipeline rule lets you define a custom JavaScript function to be executed in the frontend when a certain condition is met.
  *
  * Examples:
- * - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/triggers/execute-trigger.tsx)
- * - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/triggers/execute-trigger.class.tsx)
+ * - [execute-trigger.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.tsx)
+ * - [execute-trigger.class.tsx](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/triggers/execute-trigger.class.tsx)
  *
  * @group Controllers
  * @category ExecuteTrigger

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/url-manager/headless-url-manager.d.ts

@@ -18,7 +18,7 @@ export declare const initialStateSchema: Schema<Required<UrlManagerInitialState>
 /**
  * The `UrlManager` controller can parse an url fragment to extract search parameters which affect the search response.
  *
- * Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/master/packages/samples/headless-react/src/components/url-manager/url-manager.ts)
+ * Example: [url-manager.ts](https://github.com/coveo/ui-kit/blob/main/packages/samples/headless-react/src/components/url-manager/url-manager.ts)
  *
  * @group Controllers
  * @category UrlManager

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/build.d.ts

@@ -4,7 +4,15 @@ import type { OptionsExtender, OptionsTuple } from '../../common/types/utilities
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
+/**
+ * @deprecated This type should not be used directly.
+ * @internal
+ */
 export interface BuildOptions<TEngineOptions> {
     extend?: OptionsExtender<TEngineOptions>;
 }
+/**
+ * @deprecated This type should not be used directly.
+ * @internal
+ */
 export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/controller-inference.d.ts

@@ -8,6 +8,10 @@ export type InferStaticState<T extends {
 export type InferHydratedState<T extends {
     hydrateStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['hydrateStaticState']>>;
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ * {@link EngineDefinition.build} will be removed in a future version.
+ */
 export type InferBuildResult<T extends {
     build(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['build']>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/engine.d.ts

@@ -26,6 +26,9 @@ export type EngineDefinitionOptions<TOptions extends {
      */
     controllers?: TControllers;
 };
+/**
+ * @deprecated This type will be removed in the future. Use {@link CommerceEngineDefinition} instead.
+ */
 export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TEngineOptions, TSolutionType extends SolutionType> {
     /**
      * Fetches the static state on the server side using your engine definition.

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts

@@ -55,6 +55,10 @@ export type InferStaticState<T extends {
 export type InferHydratedState<T extends {
     hydrateStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['hydrateStaticState']>>;
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ * {@link EngineDefinition.build} will be removed in a future version.
+ */
 export type InferBuildResult<T extends {
     build(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['build']>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/from-build-result.d.ts

@@ -1,8 +1,16 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { ControllersMap } from './controllers.js';
 import type { EngineDefinitionBuildResult } from './engine.js';
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ * {@link EngineDefinition.build} will be removed in a future version.
+ */
 export interface FromBuildResultOptions<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
     buildResult: EngineDefinitionBuildResult<TEngine, TControllers>;
     allowedRecommendationKeys?: (keyof TControllers)[];
 }
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ * {@link EngineDefinition.build} will be removed in a future version.
+ */
 export type FromBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TOptions, TReturn> = (options: FromBuildResultOptions<TEngine, TControllers> & TOptions) => Promise<TReturn>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts

@@ -117,13 +117,12 @@ export type { QueryTrigger, QueryTriggerDefinition, QueryTriggerState, } from '.
 export { defineQueryTrigger } from './ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.js';
 export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
 export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
-export type { CommerceEngineDefinition } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
 export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
 export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
 export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
 export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
-export type { InferBuildResult, InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
-export type { Build, BuildOptions, EngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
+export type { InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
+export type { CommerceEngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
 export { Kind } from './ssr-next/commerce/types/kind.js';
 export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
 export * from './features/commerce/configuration/configuration-actions-loader.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/engine/commerce-engine.ssr.d.ts

@@ -1,20 +1,28 @@
 /**
  * Utility functions to be used for Commerce Server Side Rendering.
  */
-import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import { type CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
+import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
-import type { EngineDefinition } from '../types/engine.js';
-export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> extends EngineDefinition<TControllers, CommerceEngineOptions, TSolutionType> {
-}
+import type { CommerceEngineDefinition } from '../types/engine.js';
 /**
  * Initializes a Commerce engine definition in SSR with given controllers definitions and commerce engine config.
  * @param options - The commerce engine definition
  * @returns Three utility functions to fetch the initial state of the engine in SSR, hydrate the state in CSR,
  *  and a build function that can be used for edge cases requiring more control.
  *
+ * @remarks
+ * You can use the {@link InferStaticState} and {@link InferHydratedState} utility types with the returned engine definitions
+ * to infer the types of static and hydrated state for your controllers.
+ *
+ * @example
+ * ```ts
+ * const engineDefinition = defineCommerceEngine(engineConfig);
+ * type SearchStaticState = InferStaticState<typeof engineDefinition>;
+ * type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
+ * ```
+ *
  * @group Engine
  */
 export declare function defineCommerceEngine<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(options: CommerceEngineDefinitionOptions<TControllerDefinitions>): {

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts

@@ -1,4 +1,4 @@
 import type { SolutionType } from '../types/controller-constants.js';
 import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare const hydratedStaticStateFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts

@@ -1,4 +1,4 @@
 import { SolutionType } from '../types/controller-constants.js';
 import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare const fetchStaticStateFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
+export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts

@@ -4,7 +4,11 @@ import type { OptionsExtender, OptionsTuple } from '../../common/types/utilities
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
-export interface BuildOptions<TEngineOptions> {
+interface BuildOptions<TEngineOptions> {
     extend?: OptionsExtender<TEngineOptions>;
 }
+/**
+ * @internal
+ */
 export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-inference.d.ts

@@ -8,9 +8,6 @@ export type InferStaticState<T extends {
 export type InferHydratedState<T extends {
     hydrateStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['hydrateStaticState']>>;
-export type InferBuildResult<T extends {
-    build(...args: unknown[]): Promise<unknown>;
-}> = Awaited<ReturnType<T['build']>>;
 export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
 export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
     [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts

@@ -1,19 +1,17 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
+import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { EngineConfiguration } from '../../../app/engine-configuration.js';
 import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap } from '../../common/types/controllers.js';
-import type { FromBuildResultOptions } from '../../common/types/from-build-result.js';
-import type { CommerceEngineDefinition } from '../engine/commerce-engine.ssr.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
-import type { Build, BuildOptions } from './build.js';
+import type { Build } from './build.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap } from './controller-definitions.js';
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
 import type { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
-import type { FromBuildResult } from './from-build-result.js';
 import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
-export type { FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, Build, BuildOptions, };
+export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, };
 export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
     searchActions: TSearchAction[];
     controllers: TControllers;
@@ -26,19 +24,15 @@ export type EngineDefinitionOptions<TOptions extends {
      */
     controllers?: TControllers;
 };
-export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TEngineOptions, TSolutionType extends SolutionType> {
+export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> {
     /**
      * Fetches the static state on the server side using your engine definition.
      */
-    fetchStaticState: FetchStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
+    fetchStaticState: FetchStaticState<UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
     /**
      * Fetches the hydrated state on the client side using your engine definition and the static state.
      */
     hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
-    /**
-     * Builds an engine and its controllers from an engine definition.
-     */
-    build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
     /**
      * Sets the navigator context provider.
      * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
@@ -58,16 +52,11 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
 }
 export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
 type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
-type BuildFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['build'];
 export type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['fetchStaticState'];
 export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['hydrateStaticState'];
-type FetchStaticStateFromBuildResultFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = FetchStaticStateFunction<TControllerDefinitions>['fromBuildResult'];
-type HydrateStaticStateFromBuildResultFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = HydrateStaticStateFunction<TControllerDefinitions>['fromBuildResult'];
-export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<BuildFunction<TControllerDefinitions>>;
+export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<Build<CommerceEngineOptions, InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
 export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFunction<TControllerDefinitions>>;
 export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFunction<TControllerDefinitions>>;
-export type FetchStaticStateFromBuildResultParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFromBuildResultFunction<TControllerDefinitions>>;
-export type HydrateStaticStateFromBuildResultParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFromBuildResultFunction<TControllerDefinitions>>;
 type Controllers<TControllerDefinitions extends CommerceControllerDefinitionsMap> = InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
 export type BuildResult<TControllerDefinitions extends CommerceControllerDefinitionsMap> = {
     engine: SSRCommerceEngine;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts

@@ -1,17 +1,13 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { ControllerStaticStateMap, ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
+import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
 import type { EngineStaticState } from './engine.js';
-import type { FromBuildResult } from './from-build-result.js';
 export type FetchStaticStateOptions = {};
-export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
-    /**
-     * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
-     *
-     * Useful for static generation and server-side rendering.
-     */
-    (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
-    fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
-};
+/**
+ * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
+ *
+ * Useful for static generation and server-side rendering.
+ */
+export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;