@coveo/quantic 3.15.0 → 3.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +6 -6
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-client.d.ts +2 -2
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +4 -3
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +1 -1
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/request.d.ts +2 -2
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +17 -1
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/app/navigatorContextProvider.d.ts +6 -0
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts +4 -0
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/base-commerce-api-request-builder.d.ts +5 -0
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/filterable-commerce-api-request-builder.d.ts +6 -0
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/paginated-commerce-api-request-builder.d.ts +6 -0
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/commerce-facet-search-state.d.ts +2 -2
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions-loader.d.ts +1 -2
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions.d.ts +7 -2
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/query-suggest-actions.d.ts +0 -3
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/query-suggest-request-builder.d.ts +4 -0
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +2 -2
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions-thunk-processor.d.ts +6 -6
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts +8 -0
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.d.ts +3 -2
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/standalone-search-box-set-actions.d.ts +2 -6
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/features/document-suggestion/document-suggestion-actions.d.ts +2 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-commerce-api-request.d.ts +4 -0
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-product-listing.d.ts +1 -1
  26. package/force-app/main/default/staticresources/coveoheadless/headless.js +8 -8
  27. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +7 -7
  28. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +6 -6
  29. package/package.json +3 -3
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-field-suggestions-generator.ssr.d.ts +0 -16
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-field-suggestions.d.ts +0 -72
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/actions.d.ts +0 -13
@@ -5,7 +5,7 @@ import { PlatformEnvironment } from '../../utils/url-utils.js';
5
5
  import { PreprocessRequest } from '../preprocess-request.js';
6
6
  import { SpecificFacetSearchResponse } from '../search/facet-search/specific-facet-search/specific-facet-search-response.js';
7
7
  import { CommerceAPIErrorResponse, CommerceAPIErrorStatusResponse } from './commerce-api-error-response.js';
8
- import { CommerceAPIRequest } from './common/request.js';
8
+ import { FilterableCommerceAPIRequest } from './common/request.js';
9
9
  import { CommerceSuccessResponse } from './common/response.js';
10
10
  import { CommerceFacetSearchRequest, FacetSearchType } from './facet-search/facet-search-request.js';
11
11
  import { CommerceRecommendationsRequest } from './recommendations/recommendations-request.js';
@@ -34,7 +34,7 @@ export declare const isErrorResponse: <T>(r: CommerceAPIResponse<T>) => r is Com
34
34
  export declare class CommerceAPIClient implements CommerceFacetSearchAPIClient {
35
35
  private options;
36
36
  constructor(options: CommerceAPIClientOptions);
37
- getProductListing(req: CommerceAPIRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
37
+ getProductListing(req: FilterableCommerceAPIRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
38
38
  search(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;
39
39
  getRecommendations(req: CommerceRecommendationsRequest): Promise<CommerceAPIResponse<RecommendationsCommerceSuccessResponse>>;
40
40
  productSuggestions(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;
@@ -2,9 +2,10 @@ import { PlatformClientCallOptions } from '../../platform-client.js';
2
2
  import { BaseParam } from '../../platform-service-params.js';
3
3
  import { TrackingIdParam, LanguageParam, CountryParam, CurrencyParam, ClientIdParam, ContextParam, FacetsParam, PageParam, SortParam, PerPageParam } from '../commerce-api-params.js';
4
4
  import { CommerceApiMethod } from '../commerce-metadata.js';
5
- export type BaseCommerceAPIRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & PageParam & PerPageParam;
6
- export type CommerceAPIRequest = BaseCommerceAPIRequest & FacetsParam & SortParam;
7
- export declare const buildRequest: (req: CommerceAPIRequest, path: CommerceApiMethod) => {
5
+ export type BaseCommerceAPIRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam;
6
+ export type PaginatedCommerceAPIRequest = BaseCommerceAPIRequest & PageParam & PerPageParam;
7
+ export type FilterableCommerceAPIRequest = PaginatedCommerceAPIRequest & FacetsParam & SortParam;
8
+ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path: CommerceApiMethod) => {
8
9
  requestParams: {
9
10
  trackingId: string;
10
11
  clientId: string | undefined;
@@ -1,7 +1,7 @@
1
1
  import { SlotIdParam } from '../commerce-api-params.js';
2
2
  import { CommerceApiMethod } from '../commerce-metadata.js';
3
- import { BaseCommerceAPIRequest } from '../common/request.js';
4
- export type CommerceRecommendationsRequest = BaseCommerceAPIRequest & SlotIdParam;
3
+ import { PaginatedCommerceAPIRequest } from '../common/request.js';
4
+ export type CommerceRecommendationsRequest = PaginatedCommerceAPIRequest & SlotIdParam;
5
5
  export declare const buildRecommendationsRequest: (req: CommerceRecommendationsRequest, path: CommerceApiMethod) => {
6
6
  requestParams: {
7
7
  slotId: string;
@@ -1,7 +1,7 @@
1
1
  import { BaseParam } from '../../../platform-service-params.js';
2
2
  import { ClientIdParam, CurrencyParam, LanguageParam, QueryParam, TrackingIdParam, ContextParam, CountryParam } from '../../commerce-api-params.js';
3
3
  export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam;
4
- export declare const buildQuerySuggestRequest: (req: QuerySuggestRequest) => {
4
+ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) => {
5
5
  requestParams: {
6
6
  trackingId: string;
7
7
  query: string | undefined;
@@ -1,3 +1,3 @@
1
1
  import { QueryParam } from '../commerce-api-params.js';
2
- import { CommerceAPIRequest } from '../common/request.js';
3
- export type CommerceSearchRequest = CommerceAPIRequest & QueryParam;
2
+ import { FilterableCommerceAPIRequest } from '../common/request.js';
3
+ export type CommerceSearchRequest = FilterableCommerceAPIRequest & QueryParam;
@@ -1,12 +1,28 @@
1
1
  import { BaseParam, ClientIDParam, ContextParam, DebugParam, LocaleParam, NumberOfResultsParam } from '../../../platform-service-params.js';
2
+ import { AnalyticsParam } from '../../../search/search-api-params.js';
2
3
  import { CaseAssistIdParam, FieldsParam } from '../case-assist-params.js';
3
- export type GetDocumentSuggestionsRequest = BaseParam & CaseAssistIdParam & ClientIDParam & LocaleParam & FieldsParam & ContextParam & NumberOfResultsParam & DebugParam;
4
+ export type GetDocumentSuggestionsRequest = BaseParam & CaseAssistIdParam & ClientIDParam & LocaleParam & FieldsParam & ContextParam & NumberOfResultsParam & DebugParam & AnalyticsParam;
4
5
  export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSuggestionsRequest) => {
5
6
  requestParams: {
6
7
  clientId: string | undefined;
7
8
  locale: string | undefined;
8
9
  fields: import("../case-assist-params.js").CaseFields;
9
10
  context: Record<string, string | string[]> | undefined;
11
+ analytics: {
12
+ actionCause?: string;
13
+ customData?: object;
14
+ clientId: string;
15
+ deviceId?: string;
16
+ pageId?: string;
17
+ clientTimestamp: string;
18
+ documentReferrer: string | null;
19
+ originContext: string;
20
+ userDisplayName?: string;
21
+ documentLocation?: string | null;
22
+ trackingId?: string;
23
+ capture?: boolean;
24
+ source?: string[];
25
+ } | undefined;
10
26
  };
11
27
  url: string;
12
28
  accessToken: string;
@@ -20,6 +20,12 @@ export interface NavigatorContext {
20
20
  * See [clientId](https://docs.coveo.com/en/masb0234).
21
21
  */
22
22
  clientId: string;
23
+ /**
24
+ * Whether to capture analytics events.
25
+ *
26
+ * Must be left undefined or set to `false` if the `clientId` is an empty string, otherwise requests will fail.
27
+ */
28
+ capture?: boolean;
23
29
  }
24
30
  export type NavigatorContextProvider = () => NavigatorContext;
25
31
  export type BrowserNavigatorContextProvider = (clientId: string) => NavigatorContext;
@@ -87,6 +87,10 @@ export declare enum SearchPageEvents {
87
87
  * Identifies the search event that gets logged when the sort criteria on a facet is updated.
88
88
  */
89
89
  facetUpdateSort = "facetUpdateSort",
90
+ /**
91
+ * Identifies the search event that gets logged when the document suggestions are fetched.
92
+ */
93
+ documentSuggestion = "documentSuggestion",
90
94
  /**
91
95
  * The custom event that gets logged when an end-user expands a facet to see additional values.
92
96
  */
@@ -0,0 +1,5 @@
1
+ import { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
2
+ import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
3
+ import { CartSection, CommerceConfigurationSection, CommerceContextSection, VersionSection } from '../../../state/state-sections.js';
4
+ export type StateNeededForBaseCommerceAPIRequest = CommerceConfigurationSection & CommerceContextSection & CartSection & Partial<VersionSection>;
5
+ export declare const buildBaseCommerceAPIRequest: (state: StateNeededForBaseCommerceAPIRequest, navigatorContext: NavigatorContext) => BaseCommerceAPIRequest;
@@ -0,0 +1,6 @@
1
+ import { FilterableCommerceAPIRequest } from '../../../api/commerce/common/request.js';
2
+ import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
3
+ import { CommerceFacetSetSection, CommerceSortSection, FacetOrderSection, ManualRangeSection } from '../../../state/state-sections.js';
4
+ import { StateNeededForPaginatedCommerceAPIRequest } from './paginated-commerce-api-request-builder.js';
5
+ export type StateNeededForFilterableCommerceAPIRequest = StateNeededForPaginatedCommerceAPIRequest & Partial<CommerceSortSection & CommerceFacetSetSection & FacetOrderSection & ManualRangeSection>;
6
+ export declare const buildFilterableCommerceAPIRequest: (state: StateNeededForFilterableCommerceAPIRequest, navigatorContext: NavigatorContext) => FilterableCommerceAPIRequest;
@@ -0,0 +1,6 @@
1
+ import { PaginatedCommerceAPIRequest } from '../../../api/commerce/common/request.js';
2
+ import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
3
+ import { CommercePaginationSection } from '../../../state/state-sections.js';
4
+ import { StateNeededForBaseCommerceAPIRequest } from './base-commerce-api-request-builder.js';
5
+ export type StateNeededForPaginatedCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & Partial<CommercePaginationSection>;
6
+ export declare const buildPaginatedCommerceAPIRequest: (state: StateNeededForPaginatedCommerceAPIRequest, navigatorContext: NavigatorContext, slotId?: string) => PaginatedCommerceAPIRequest;
@@ -1,6 +1,6 @@
1
1
  import { CommerceFacetSetSection, CommerceQuerySection } from '../../../../state/state-sections.js';
2
- import { StateNeededByQueryCommerceAPI } from '../../common/actions.js';
2
+ import { StateNeededForPaginatedCommerceAPIRequest } from '../../common/paginated-commerce-api-request-builder.js';
3
3
  import { StateNeededForCategoryFacetSearch } from './category/commerce-category-facet-search-state.js';
4
4
  import { StateNeededForRegularFacetSearch } from './regular/commerce-regular-facet-search-state.js';
5
- export type CoreStateNeededForFacetSearch = StateNeededByQueryCommerceAPI & CommerceFacetSetSection & Partial<CommerceQuerySection>;
5
+ export type CoreStateNeededForFacetSearch = StateNeededForPaginatedCommerceAPIRequest & CommerceFacetSetSection & Partial<CommerceQuerySection>;
6
6
  export type StateNeededForAnyFacetSearch = StateNeededForRegularFacetSearch | StateNeededForCategoryFacetSearch;
@@ -1,8 +1,7 @@
1
1
  import { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
2
2
  import { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
3
3
  import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
4
- import { QueryCommerceAPIThunkReturn } from '../common/actions.js';
5
- import { PromoteChildToParentPayload, StateNeededByFetchProductListing } from './product-listing-actions.js';
4
+ import { PromoteChildToParentPayload, QueryCommerceAPIThunkReturn, StateNeededByFetchProductListing } from './product-listing-actions.js';
6
5
  /**
7
6
  * The product listing action creators.
8
7
  *
@@ -1,8 +1,13 @@
1
1
  import { RecordValue } from '@coveo/bueno';
2
2
  import { ChildProduct } from '../../../api/commerce/common/product.js';
3
+ import { CommerceSuccessResponse } from '../../../api/commerce/common/response.js';
3
4
  import { ProductListingSection } from '../../../state/state-sections.js';
4
- import { QueryCommerceAPIThunkReturn, ListingAndSearchStateNeededByQueryCommerceAPI } from '../common/actions.js';
5
- export type StateNeededByFetchProductListing = ListingAndSearchStateNeededByQueryCommerceAPI & ProductListingSection;
5
+ import { StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
6
+ export interface QueryCommerceAPIThunkReturn {
7
+ /** The successful response. */
8
+ response: CommerceSuccessResponse;
9
+ }
10
+ export type StateNeededByFetchProductListing = StateNeededForFilterableCommerceAPIRequest & ProductListingSection;
6
11
  export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, void, {
7
12
  state: StateNeededByFetchProductListing;
8
13
  rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
@@ -1,6 +1,4 @@
1
- import { QuerySuggestRequest } from '../../../api/commerce/search/query-suggest/query-suggest-request.js';
2
1
  import { QuerySuggestSuccessResponse } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
3
- import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
4
2
  import { CartSection, CommerceContextSection, CommerceQuerySection, CommerceConfigurationSection, QuerySetSection, VersionSection } from '../../../state/state-sections.js';
5
3
  import { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, RegisterQuerySuggestActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
6
4
  export type ClearQuerySuggestPayload = ClearQuerySuggestActionCreatorPayload;
@@ -27,4 +25,3 @@ export type RegisterQuerySuggestPayload = RegisterQuerySuggestActionCreatorPaylo
27
25
  export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestActionCreatorPayload], RegisterQuerySuggestActionCreatorPayload, "commerce/querySuggest/register", never, never>;
28
26
  export type SelectQuerySuggestionPayload = SelectQuerySuggestionActionCreatorPayload;
29
27
  export declare const selectQuerySuggestion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SelectQuerySuggestionActionCreatorPayload], SelectQuerySuggestionActionCreatorPayload, "commerce/querySuggest/selectSuggestion", never, never>;
30
- export declare const buildQuerySuggestRequest: (id: string, state: StateNeededByQuerySuggest, navigatorContext: NavigatorContext) => QuerySuggestRequest;
@@ -0,0 +1,4 @@
1
+ import { QuerySuggestRequest } from '../../../api/commerce/search/query-suggest/query-suggest-request.js';
2
+ import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
3
+ import { StateNeededByQuerySuggest } from './query-suggest-actions.js';
4
+ export declare const buildQuerySuggestRequest: (id: string, state: StateNeededByQuerySuggest, navigatorContext: NavigatorContext) => QuerySuggestRequest;
@@ -2,12 +2,12 @@ import { RecordValue, StringValue } from '@coveo/bueno';
2
2
  import { ChildProduct } from '../../../api/commerce/common/product.js';
3
3
  import { RecommendationsCommerceSuccessResponse } from '../../../api/commerce/recommendations/recommendations-response.js';
4
4
  import { RecommendationsSection } from '../../../state/state-sections.js';
5
- import { StateNeededByQueryCommerceAPI } from '../common/actions.js';
5
+ import { StateNeededForPaginatedCommerceAPIRequest } from '../common/paginated-commerce-api-request-builder.js';
6
6
  export interface QueryRecommendationsCommerceAPIThunkReturn {
7
7
  /** The successful recommendations response. */
8
8
  response: RecommendationsCommerceSuccessResponse;
9
9
  }
10
- export type StateNeededByFetchRecommendations = StateNeededByQueryCommerceAPI & RecommendationsSection;
10
+ export type StateNeededByFetchRecommendations = StateNeededForPaginatedCommerceAPIRequest & RecommendationsSection;
11
11
  export interface FetchRecommendationsPayload {
12
12
  /**
13
13
  * The unique identifier of the recommendations slot (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`).
@@ -2,20 +2,20 @@ import { UnknownAction } from '@reduxjs/toolkit';
2
2
  import { ThunkDispatch } from 'redux-thunk';
3
3
  import { CommerceAPIClient, CommerceAPIResponse } from '../../../api/commerce/commerce-api-client.js';
4
4
  import { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
5
- import { CommerceAPIRequest } from '../../../api/commerce/common/request.js';
5
+ import { FilterableCommerceAPIRequest } from '../../../api/commerce/common/request.js';
6
6
  import { CommerceSearchRequest } from '../../../api/commerce/search/request.js';
7
7
  import { SearchCommerceSuccessResponse } from '../../../api/commerce/search/response.js';
8
8
  import { ClientThunkExtraArguments } from '../../../app/thunk-extra-arguments.js';
9
9
  import { CommerceSearchSection, CommerceQuerySection, CommerceDidYouMeanSection, TriggerSection } from '../../../state/state-sections.js';
10
- import { ListingAndSearchStateNeededByQueryCommerceAPI } from '../common/actions.js';
10
+ import { StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
11
11
  import { QuerySearchCommerceAPIThunkReturn } from './search-actions.js';
12
12
  interface FetchedResponse {
13
13
  response: CommerceAPIResponse<SearchCommerceSuccessResponse>;
14
14
  duration: number;
15
15
  queryExecuted: string;
16
- requestExecuted: CommerceAPIRequest;
16
+ requestExecuted: FilterableCommerceAPIRequest;
17
17
  }
18
- export type StateNeededByExecuteSearch = ListingAndSearchStateNeededByQueryCommerceAPI & CommerceSearchSection & CommerceQuerySection & CommerceDidYouMeanSection & TriggerSection;
18
+ export type StateNeededByExecuteSearch = StateNeededForFilterableCommerceAPIRequest & CommerceSearchSection & CommerceQuerySection & CommerceDidYouMeanSection & TriggerSection;
19
19
  export interface AsyncThunkConfig {
20
20
  getState: () => StateNeededByExecuteSearch;
21
21
  dispatch: ThunkDispatch<StateNeededByExecuteSearch, ClientThunkExtraArguments<CommerceAPIClient> & {
@@ -29,11 +29,11 @@ export declare class AsyncSearchThunkProcessor<RejectionType> {
29
29
  private config;
30
30
  constructor(config: AsyncThunkConfig);
31
31
  process(fetched: FetchedResponse): Promise<ValidReturnTypeFromProcessingStep<RejectionType>>;
32
- fetchFromAPI(request: CommerceAPIRequest | CommerceSearchRequest): Promise<{
32
+ fetchFromAPI(request: FilterableCommerceAPIRequest | CommerceSearchRequest): Promise<{
33
33
  response: CommerceAPIResponse<SearchCommerceSuccessResponse>;
34
34
  duration: number;
35
35
  queryExecuted: string;
36
- requestExecuted: CommerceAPIRequest | CommerceSearchRequest;
36
+ requestExecuted: FilterableCommerceAPIRequest | CommerceSearchRequest;
37
37
  }>;
38
38
  private processSuccessResponse;
39
39
  private processQueryErrorOrContinue;
@@ -0,0 +1,8 @@
1
+ import { PageParam, PerPageParam, QueryParam } from '../../../api/commerce/commerce-api-params.js';
2
+ import { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
3
+ import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
4
+ import { CommerceQuerySection } from '../../../state/state-sections.js';
5
+ import { StateNeededForBaseCommerceAPIRequest } from '../common/base-commerce-api-request-builder.js';
6
+ export type StateNeededForPlanCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & CommerceQuerySection;
7
+ export type CommercePlanRequest = BaseCommerceAPIRequest & QueryParam & PageParam & PerPageParam;
8
+ export declare const buildPlanRequest: (state: StateNeededForPlanCommerceAPIRequest, navigatorContext: NavigatorContext) => CommercePlanRequest;
@@ -1,7 +1,8 @@
1
1
  import { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
2
2
  import { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
3
3
  import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
4
- import { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload, StateNeededForRedirect } from './standalone-search-box-set-actions.js';
4
+ import { StateNeededForPlanCommerceAPIRequest } from './plan-request-builder.js';
5
+ import { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload } from './standalone-search-box-set-actions.js';
5
6
  export type { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload, };
6
7
  /**
7
8
  * The commerce standalone search box set action creators.
@@ -16,7 +17,7 @@ export interface StandaloneSearchBoxSetActionCreators {
16
17
  * @param payload - The action creator payload.
17
18
  * @returns A dispatchable action.
18
19
  */
19
- fetchRedirectUrl(payload: FetchRedirectUrlPayload): AsyncThunkAction<string, FetchRedirectUrlPayload, AsyncThunkCommerceOptions<StateNeededForRedirect>>;
20
+ fetchRedirectUrl(payload: FetchRedirectUrlPayload): AsyncThunkAction<string, FetchRedirectUrlPayload, AsyncThunkCommerceOptions<StateNeededForPlanCommerceAPIRequest>>;
20
21
  /**
21
22
  * Registers a standalone search box.
22
23
  *
@@ -1,7 +1,4 @@
1
- import { CommerceSearchRequest } from '../../../api/commerce/search/request.js';
2
- import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
3
- import { CartSection, CommerceContextSection, CommerceQuerySection, CommerceConfigurationSection } from '../../../state/state-sections.js';
4
- export type StateNeededForRedirect = CommerceConfigurationSection & CommerceContextSection & CommerceQuerySection & CartSection;
1
+ import { StateNeededForPlanCommerceAPIRequest } from './plan-request-builder.js';
5
2
  export interface FetchRedirectUrlPayload {
6
3
  /**
7
4
  * The standalone search box id.
@@ -9,7 +6,7 @@ export interface FetchRedirectUrlPayload {
9
6
  id: string;
10
7
  }
11
8
  export declare const fetchRedirectUrl: import("@reduxjs/toolkit").AsyncThunk<string, FetchRedirectUrlPayload, {
12
- state: StateNeededForRedirect;
9
+ state: StateNeededForPlanCommerceAPIRequest;
13
10
  rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
14
11
  extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
15
12
  dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
@@ -51,4 +48,3 @@ export interface ResetStandaloneSearchBoxPayload {
51
48
  id: string;
52
49
  }
53
50
  export declare const resetStandaloneSearchBox: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ResetStandaloneSearchBoxPayload], ResetStandaloneSearchBoxPayload, "commerce/standaloneSearchBox/reset", never, never>;
54
- export declare const buildPlanRequest: (state: StateNeededForRedirect, navigatorContext: NavigatorContext) => CommerceSearchRequest;
@@ -1,5 +1,6 @@
1
1
  import { GetDocumentSuggestionsRequest } from '../../api/service/case-assist/get-document-suggestions/get-document-suggestions-request.js';
2
2
  import { GetDocumentSuggestionsResponse } from '../../api/service/case-assist/get-document-suggestions/get-document-suggestions-response.js';
3
+ import { NavigatorContext } from '../../app/navigatorContextProvider.js';
3
4
  import { CaseAssistConfigurationSection, DocumentSuggestionSection, ConfigurationSection, DebugSection, CaseInputSection, CaseFieldSection } from '../../state/state-sections.js';
4
5
  export interface FetchDocumentSuggestionsThunkReturn {
5
6
  /** The successful document suggestions response. */
@@ -16,4 +17,4 @@ export declare const fetchDocumentSuggestions: import("@reduxjs/toolkit").AsyncT
16
17
  fulfilledMeta?: unknown;
17
18
  rejectedMeta?: unknown;
18
19
  }>;
19
- export declare const buildFetchDocumentSuggestionsRequest: (state: StateNeededByFetchDocumentSuggestions) => Promise<GetDocumentSuggestionsRequest>;
20
+ export declare const buildFetchDocumentSuggestionsRequest: (state: StateNeededByFetchDocumentSuggestions, navigatorContext: NavigatorContext) => Promise<GetDocumentSuggestionsRequest>;
@@ -0,0 +1,4 @@
1
+ import { BaseCommerceAPIRequest, FilterableCommerceAPIRequest, PaginatedCommerceAPIRequest } from '../api/commerce/common/request.js';
2
+ export declare const buildMockBaseCommerceAPIRequest: (config?: Partial<BaseCommerceAPIRequest>) => BaseCommerceAPIRequest;
3
+ export declare const buildMockPaginatedCommerceAPIRequest: (config?: Partial<PaginatedCommerceAPIRequest>) => PaginatedCommerceAPIRequest;
4
+ export declare const buildMockFilterableCommerceAPIRequest: (config?: Partial<FilterableCommerceAPIRequest>) => FilterableCommerceAPIRequest;
@@ -1,3 +1,3 @@
1
1
  import { CommerceSuccessResponse } from '../api/commerce/common/response.js';
2
- import { QueryCommerceAPIThunkReturn } from '../features/commerce/common/actions.js';
2
+ import { QueryCommerceAPIThunkReturn } from '../features/commerce/product-listing/product-listing-actions.js';
3
3
  export declare function buildFetchProductListingResponse(response?: Partial<CommerceSuccessResponse>): QueryCommerceAPIThunkReturn;