@coveo/quantic 3.33.5 → 3.34.0

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/result.d.ts

@@ -0,0 +1,52 @@
+import type { BaseProduct, Product } from './product.js';
+export declare enum ResultType {
+    CHILD_PRODUCT = "childProduct",
+    PRODUCT = "product",
+    SPOTLIGHT = "spotlight"
+}
+export interface BaseSpotlightContent {
+    /**
+     * The unique identifier of the spotlight content.
+     */
+    id: string;
+    /**
+     * The URI to navigate to when the spotlight content is clicked.
+     */
+    clickUri: string;
+    /**
+     * The image URL for desktop display.
+     */
+    desktopImage: string;
+    /**
+     * The image URL for mobile display.
+     */
+    mobileImage?: string;
+    /**
+     * The name of the spotlight content.
+     */
+    name?: string;
+    /**
+     * The description of the spotlight content.
+     */
+    description?: string;
+    /**
+     * The ID of the response that returned the spotlight content.
+     */
+    responseId?: string;
+    /**
+     * The result type identifier, always SPOTLIGHT for spotlight content.
+     */
+    resultType: ResultType.SPOTLIGHT;
+}
+export interface ResultPosition {
+    /**
+     * The 1-based result's position across the non-paginated result set.
+     *
+     * For example, if the result is the third one on the second page, and there are 10 results per page, its position is 13 (not 3).
+     */
+    position: number;
+}
+export interface SpotlightContent extends ResultPosition, BaseSpotlightContent {
+}
+export type BaseResult = BaseProduct | BaseSpotlightContent;
+export type Result = Product | SpotlightContent;

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

@@ -0,0 +1,3 @@
+import type { EnableResultsParam } from '../commerce-api-params.js';
+import type { FilterableCommerceAPIRequest } from '../common/request.js';
+export type CommerceListingRequest = FilterableCommerceAPIRequest & EnableResultsParam;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/listing/response.d.ts

@@ -0,0 +1,5 @@
+import type { CommerceSuccessResponse } from '../common/response.js';
+import type { BaseResult } from '../common/result.js';
+export interface ListingCommerceSuccessResponse extends CommerceSuccessResponse {
+    results: BaseResult[];
+}

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

@@ -22,6 +22,8 @@ export type { Relay } from '@coveo/relay';
 export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { BaseResult, Result, SpotlightContent, } from './api/commerce/common/result.js';
+export { ResultType } from './api/commerce/common/result.js';
 export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
 export type { CommerceEngine, CommerceEngineConfiguration, CommerceEngineOptions, } from './app/commerce-engine/commerce-engine.js';
 export { buildCommerceEngine } from './app/commerce-engine/commerce-engine.js';
@@ -94,7 +96,7 @@ export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers,
 export { buildFilterSuggestionsGenerator } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
 export type { InstantProducts, InstantProductsOptions, InstantProductsProps, InstantProductsState, } from './controllers/commerce/instant-products/headless-instant-products.js';
 export { buildInstantProducts } from './controllers/commerce/instant-products/headless-instant-products.js';
-export type { ProductListing, ProductListingState, } from './controllers/commerce/product-listing/headless-product-listing.js';
+export type { ProductListing, ProductListingOptions, ProductListingState, } from './controllers/commerce/product-listing/headless-product-listing.js';
 export { buildProductListing } from './controllers/commerce/product-listing/headless-product-listing.js';
 export type { ProductListingSummaryState } from './controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
 export type { ProductView } from './controllers/commerce/product-view/headless-product-view.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts

@@ -1,7 +1,9 @@
 import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
 import type { ChildProduct, Product } from '../../../api/commerce/common/product.js';
+import type { Result } from '../../../api/commerce/common/result.js';
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Parameters } from '../../../features/commerce/parameters/parameters-actions.js';
+import type { FetchProductListingPayload } from '../../../features/commerce/product-listing/product-listing-actions.js';
 import { type Controller } from '../../controller/headless-controller.js';
 import { type SearchAndListingSubControllers } from '../core/sub-controller/headless-sub-controller.js';
 import type { ProductListingSummaryState } from './summary/headless-product-listing-summary.js';
@@ -51,17 +53,26 @@ export interface ProductListing extends Controller, SearchAndListingSubControlle
  */
 export interface ProductListingState {
     products: Product[];
+    results: Result[];
     error: CommerceAPIErrorStatusResponse | null;
     isLoading: boolean;
     responseId: string;
 }
+/**
+ * Options for configuring the `ProductListing` controller.
+ * @group Buildable controllers
+ * @category ProductListing
+ */
+export interface ProductListingOptions extends FetchProductListingPayload {
+}
 /**
  * Creates a `ProductListing` controller instance.
  *
  * @param engine - The headless commerce engine.
+ * @param options - The configurable `ProductListing` controller options.
  * @returns A `ProductListing` controller instance.
  *
  * @group Buildable controllers
  * @category ProductListing
  */
-export declare function buildProductListing(engine: CommerceEngine): ProductListing;
+export declare function buildProductListing(engine: CommerceEngine, { enableResults }?: ProductListingOptions): ProductListing;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions-loader.d.ts

@@ -1,7 +1,7 @@
 import type { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
 import type { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import { type PromoteChildToParentPayload, type QueryCommerceAPIThunkReturn, type StateNeededByFetchProductListing } from './product-listing-actions.js';
+import type { FetchProductListingPayload, PromoteChildToParentPayload, QueryCommerceAPIThunkReturn, StateNeededByFetchProductListing } from './product-listing-actions.js';
 /**
  * The product listing action creators.
  *
@@ -14,13 +14,13 @@ export interface ProductListingActionCreators {
      *
      * @returns A dispatchable action.
      */
-    fetchProductListing(): AsyncThunkAction<QueryCommerceAPIThunkReturn, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
+    fetchProductListing(payload?: FetchProductListingPayload): AsyncThunkAction<QueryCommerceAPIThunkReturn, FetchProductListingPayload, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
     /**
      * Fetches and additional page of products and appends it to the current list.
      *
      * @returns A dispatchable action.
      */
-    fetchMoreProducts(): AsyncThunkAction<QueryCommerceAPIThunkReturn | null, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
+    fetchMoreProducts(payload?: FetchProductListingPayload): AsyncThunkAction<QueryCommerceAPIThunkReturn | null, FetchProductListingPayload, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
     /**
      * Promotes a child product to a parent product.
      *

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

@@ -1,13 +1,21 @@
 import type { ChildProduct } from '../../../api/commerce/common/product.js';
-import type { CommerceSuccessResponse } from '../../../api/commerce/common/response.js';
+import type { ListingCommerceSuccessResponse } from '../../../api/commerce/listing/response.js';
 import type { ProductListingSection } from '../../../state/state-sections.js';
 import { type StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
 export interface QueryCommerceAPIThunkReturn {
     /** The successful response. */
-    response: CommerceSuccessResponse;
+    response: ListingCommerceSuccessResponse;
 }
 export type StateNeededByFetchProductListing = StateNeededForFilterableCommerceAPIRequest & ProductListingSection;
-export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, void, {
+export interface FetchProductListingPayload {
+    /**
+     * 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.
+     * @default false
+     */
+    enableResults?: boolean;
+}
+export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, FetchProductListingPayload, {
     state: StateNeededByFetchProductListing;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
     extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
@@ -17,7 +25,7 @@ export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn | null, void, {
+export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn | null, FetchProductListingPayload, {
     state: StateNeededByFetchProductListing;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
     extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-state.d.ts

@@ -1,5 +1,6 @@
 import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
 import type { Product } from '../../../api/commerce/common/product.js';
+import type { Result } from '../../../api/commerce/common/result.js';
 import type { AnyFacetResponse } from '../facets/facet-set/interfaces/response.js';
 export interface ProductListingState {
     error: CommerceAPIErrorStatusResponse | null;
@@ -8,5 +9,6 @@ export interface ProductListingState {
     responseId: string;
     facets: AnyFacetResponse[];
     products: Product[];
+    results: Result[];
 }
 export declare const getProductListingInitialState: () => ProductListingState;

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

@@ -1,5 +1,5 @@
 /**
- * The Coveo Headless SSR Commerce sub-package exposes exposes the engine, definers, controllers, actions, and utility functions to build a server side rendered commerce experience.
+ * The Coveo Headless SSR Commerce sub-package exposes the engine, definers, controllers, actions, and utility functions to build a server side rendered commerce experience.
  *
  * @example
  * ```typescript
@@ -151,6 +151,7 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
 export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export { ResultType } from './api/commerce/common/result.js';
 export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
 export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
 export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-product-listing.d.ts

@@ -1,3 +1,3 @@
-import type { CommerceSuccessResponse } from '../api/commerce/common/response.js';
+import type { ListingCommerceSuccessResponse } from '../api/commerce/listing/response.js';
 import type { QueryCommerceAPIThunkReturn } from '../features/commerce/product-listing/product-listing-actions.js';
-export declare function buildFetchProductListingResponse(response?: Partial<CommerceSuccessResponse>): QueryCommerceAPIThunkReturn;
+export declare function buildFetchProductListingResponse(response?: Partial<ListingCommerceSuccessResponse>): QueryCommerceAPIThunkReturn;

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-spotlight-content.d.ts

@@ -0,0 +1,3 @@
+import type { BaseSpotlightContent, SpotlightContent } from '../api/commerce/common/result.js';
+export declare function buildMockBaseSpotlightContent(config?: Partial<BaseSpotlightContent>): BaseSpotlightContent;
+export declare function buildMockSpotlightContent(config?: Partial<SpotlightContent>): SpotlightContent;