@coveo/quantic 3.33.6 → 3.34.1

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/spotlight-content/spotlight-content-actions-loaders.d.ts

@@ -0,0 +1,29 @@
+import type { AsyncThunkAction } from '@reduxjs/toolkit';
+import type { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
+import type { CommerceEngineState } from '../../../app/commerce-engine/commerce-engine.js';
+import { type SpotlightContentClickPayload } from './spotlight-content-actions.js';
+export type { SpotlightContentClickPayload };
+/**
+ * The spotlight content action creators.
+ *
+ * @group Actions
+ * @category SpotlightContent
+ */
+export interface SpotlightContentActionCreators {
+    /**
+     * Logs a click analytics event for a spotlight content item.
+     *
+     * @param payload - The action creator payload.
+     * @returns A dispatchable action.
+     */
+    spotlightContentClick(payload: SpotlightContentClickPayload): AsyncThunkAction<void, SpotlightContentClickPayload, AsyncThunkCommerceOptions<CommerceEngineState>>;
+}
+/**
+ * Returns the possible spotlight content action creators.
+ *
+ * @returns An object holding the action creators.
+ *
+ * @group Actions
+ * @category SpotlightContent
+ */
+export declare function loadSpotlightContentActions(): SpotlightContentActionCreators;

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

@@ -0,0 +1,29 @@
+import type { CommerceEngineState } from '../../../app/commerce-engine/commerce-engine.js';
+export interface SpotlightContentClickPayload {
+    /**
+     * The unique identifier of the spotlight content.
+     */
+    id: string;
+    /**
+     * The desktop image URL of the spotlight content.
+     */
+    desktopImage: string;
+    /**
+     * The 1-based position of the spotlight content in the result set.
+     */
+    position: number;
+    /**
+     * The response ID associated with the spotlight content.
+     */
+    responseId: string;
+}
+export declare const spotlightContentClick: import("@reduxjs/toolkit").AsyncThunk<void, SpotlightContentClickPayload, {
+    state: CommerceEngineState;
+    rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
+    extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;

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/state/commerce-app-state.d.ts

@@ -1,4 +1,4 @@
-import type { CartSection, CategoryFacetSearchSection, CommerceConfigurationSection, CommerceContextSection, CommerceDidYouMeanSection, CommerceFacetSetSection, CommercePaginationSection, CommerceParametersSection, CommerceQuerySection, CommerceSearchSection, CommerceSortSection, CommerceStandaloneSearchBoxSection, FacetOrderSection, FacetSearchSection, FieldSuggestionsOrderSection, InstantProductsSection, ManualRangeSection, ProductListingSection, QuerySetSection, QuerySuggestionSection, RecentQueriesSection, RecommendationsSection, TriggerSection, VersionSection } from './state-sections.js';
+import type { CartSection, CategoryFacetSearchSection, CommerceConfigurationSection, CommerceContextSection, CommerceDidYouMeanSection, CommerceFacetSetSection, CommercePaginationSection, CommerceParametersSection, CommerceQuerySection, CommerceSearchSection, CommerceSortSection, CommerceStandaloneSearchBoxSection, FacetOrderSection, FacetSearchSection, FieldSuggestionsOrderSection, InstantProductsSection, ManualRangeSection, ProductEnrichmentSection, ProductListingSection, QuerySetSection, QuerySuggestionSection, RecentQueriesSection, RecommendationsSection, TriggerSection, VersionSection } from './state-sections.js';
 export type CommerceProductListingParametersState = CommerceFacetSetSection & CommerceSortSection & CommercePaginationSection;
 export type CommerceSearchParametersState = CommerceProductListingParametersState & CommerceQuerySection;
-export type CommerceAppState = CommerceConfigurationSection & CommerceStandaloneSearchBoxSection & ProductListingSection & RecommendationsSection & CommerceSearchSection & CommerceQuerySection & FacetOrderSection & FacetSearchSection & CategoryFacetSearchSection & CommerceFacetSetSection & CommercePaginationSection & CommerceSortSection & CommerceContextSection & CommerceParametersSection & CartSection & RecentQueriesSection & QuerySuggestionSection & QuerySetSection & CommerceDidYouMeanSection & InstantProductsSection & FieldSuggestionsOrderSection & TriggerSection & ManualRangeSection & VersionSection;
+export type CommerceAppState = CommerceConfigurationSection & CommerceStandaloneSearchBoxSection & ProductListingSection & RecommendationsSection & CommerceSearchSection & CommerceQuerySection & FacetOrderSection & FacetSearchSection & CategoryFacetSearchSection & CommerceFacetSetSection & CommercePaginationSection & CommerceSortSection & CommerceContextSection & CommerceParametersSection & CartSection & RecentQueriesSection & QuerySuggestionSection & QuerySetSection & CommerceDidYouMeanSection & InstantProductsSection & FieldSuggestionsOrderSection & TriggerSection & ManualRangeSection & ProductEnrichmentSection & VersionSection;

package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts

@@ -17,6 +17,7 @@ import type { ManualNumericFacetSetState } from '../features/commerce/facets/num
 import type { InstantProductsState } from '../features/commerce/instant-products/instant-products-state.js';
 import type { CommercePaginationState } from '../features/commerce/pagination/pagination-state.js';
 import type { CommerceParametersState } from '../features/commerce/parameters/parameters-state.js';
+import type { ProductEnrichmentState } from '../features/commerce/product-enrichment/product-enrichment-state.js';
 import type { ProductListingState } from '../features/commerce/product-listing/product-listing-state.js';
 import type { CommerceQueryState } from '../features/commerce/query/query-state.js';
 import type { RecommendationsState as CommerceRecommendationsState } from '../features/commerce/recommendations/recommendations-state.js';
@@ -365,6 +366,12 @@ export interface RecentQueriesSection {
      */
     recentQueries: RecentQueriesState;
 }
+export interface ProductEnrichmentSection {
+    /**
+     * The product enrichment state containing badge placements.
+     */
+    productEnrichment: ProductEnrichmentState;
+}
 export interface CaseAssistConfigurationSection {
     /**
      * The case assist engine configuration

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

@@ -0,0 +1,6 @@
+import type { Badge, BadgePlacement, BadgesProduct, ProductEnrichmentSuccessBadgesResponse } from '../api/commerce/product-enrichment/product-enrichment-response.js';
+import type { FetchBadgesThunkReturn } from '../features/commerce/product-enrichment/product-enrichment-actions.js';
+export declare function buildMockBadge(config?: Partial<Badge>): Badge;
+export declare function buildMockBadgePlacement(config?: Partial<BadgePlacement>): BadgePlacement;
+export declare function buildMockBadgesProduct(config?: Partial<BadgesProduct>): BadgesProduct;
+export declare function buildFetchBadgesResponse(config?: Partial<ProductEnrichmentSuccessBadgesResponse>): FetchBadgesThunkReturn;

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;