@coveo/quantic 3.27.0-pre.e8e95b2dbe → 3.27.0
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.
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/base-analytics.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/history-store.d.ts +1 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-client.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-params.d.ts +5 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-response.d.ts +2 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/common/trigger.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/generated-answer/generated-answer-client.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/generated-answer/generated-answer-event-payload.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +8 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +119 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/platform-client.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/fields/fields-response.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts +7 -20
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-api-client.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +5 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +5 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-response.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-api-client.d.ts +5 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/common.d.ts +9 -12
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/core-engine.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/from-build-result.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/jwt-reducer.d.ts +0 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/build.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/common.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/fetch-static-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/hydrate-static-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/headless-core-commerce-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-category-field-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-view/headless-product-view.ssr.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search-box/headless-search-box.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/standalone-search-box/headless-standalone-search-box.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-context-reserved-keys.d.ts +1 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-context.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/_common/facet-option-definitions.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-date-facet-options.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/headless-core-range-facet.d.ts +7 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-numeric-facet-options.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-generated-answer.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-interactive-citation.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-searchapi-generated-answer.d.ts +2 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-box/headless-core-search-box-options.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-parameter-manager/headless-core-search-parameter-manager.d.ts +0 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet/headless-core-smart-snippet.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet/headless-automatic-facet.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/category-facet/headless-category-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/category-facet/headless-insight-category-facet.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/generated-answer/headless-insight-generated-answer.d.ts +1 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet/headless-insight-smart-snippet-interactive-inline-links.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-interactive-questions.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results-options.d.ts +1 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet/headless-smart-snippet-interactive-inline-links.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-interactive-questions.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/tab-manager/headless-tab-manager.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-notify-trigger.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-notify-trigger.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-redirection-trigger.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-queries-state.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-actions.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +11 -17
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/legacy-search-action-cause.d.ts +1 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-actions.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions.d.ts +104 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-actions.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-state.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-input/case-input-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/commerce-facet-search-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/facet-set-reducers.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/interfaces/request.d.ts +2 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/interfaces/response.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/manual-numeric-facet-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-selectors.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.ssr.d.ts +1 -23
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-templates/product-templates-helpers.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recent-queries/recent-queries-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +2 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions.d.ts +3 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +0 -21
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/standalone-search-box-set-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/ranking-info-parser.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/document-suggestion/document-suggestion-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-validate-payload.d.ts +0 -9
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-insight-analytics-actions.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-insight-utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/generic/facet-reducer-helpers.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/interfaces/response.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/options.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/range-facet.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/request.d.ts +1 -11
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/range-facet-utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/interfaces/response.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/folding/folding-analytics-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-configuration/insight-configuration-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-search/insight-search-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-user-actions/insight-user-actions-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-user-actions/insight-user-actions-preprocessing.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/instant-results/instant-results-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-actions.d.ts +0 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/result/result-insight-analytics-actions.d.ts +52 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions-thunk-processor.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions.d.ts +0 -82
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions-thunk-processor.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +0 -65
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-actions.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-serializer.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/standalone-search-box-set/standalone-search-box-set-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/templates/templates-manager.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/state/insight-app-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-commerce-api-request.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-engine-v2.d.ts +0 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/fetch.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/url-utils.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
- package/package.json +6 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.ssr.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/utils/load-product-listing-reducers.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/utils/load-search-reducers.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts +0 -32
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-internal-context.d.ts +0 -31
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-strict-context-factory.d.ts +0 -13
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/response.d.ts +0 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-actions-loader.d.ts +0 -35
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-slice.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-state.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-insight-api-client.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/index.d.ts +0 -2
|
@@ -12,19 +12,19 @@ export interface InlineLink {
|
|
|
12
12
|
/**
|
|
13
13
|
* @internal
|
|
14
14
|
*/
|
|
15
|
-
|
|
15
|
+
interface SmartSnippetInteractiveInlineLinksOptions {
|
|
16
16
|
selectionDelay?: number;
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
19
|
* @internal
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
interface SmartSnippetInteractiveInlineLinksProps {
|
|
22
22
|
options?: SmartSnippetInteractiveInlineLinksOptions;
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @internal
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
interface SmartSnippetInteractiveInlineLinks {
|
|
28
28
|
selectInlineLink(link: InlineLink, questionAnswerId?: string): void;
|
|
29
29
|
beginDelayedSelectInlineLink(link: InlineLink, questionAnswerId?: string): void;
|
|
30
30
|
cancelPendingSelectInlineLink(link: InlineLink, questionAnswerId?: string): void;
|
|
@@ -33,3 +33,4 @@ export interface SmartSnippetInteractiveInlineLinks {
|
|
|
33
33
|
* @internal
|
|
34
34
|
*/
|
|
35
35
|
export declare function buildSmartSnippetInteractiveInlineLinks(engine: SearchEngine, props?: SmartSnippetInteractiveInlineLinksProps): SmartSnippetInteractiveInlineLinks;
|
|
36
|
+
export {};
|
|
@@ -2,19 +2,19 @@ import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
|
2
2
|
/**
|
|
3
3
|
* @internal
|
|
4
4
|
*/
|
|
5
|
-
|
|
5
|
+
interface SmartSnippetInteractiveQuestionsOptions {
|
|
6
6
|
selectionDelay?: number;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* @internal
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
interface SmartSnippetInteractiveQuestionsProps {
|
|
12
12
|
options?: SmartSnippetInteractiveQuestionsOptions;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* @internal
|
|
16
16
|
*/
|
|
17
|
-
|
|
17
|
+
interface SmartSnippetInteractiveQuestions {
|
|
18
18
|
selectSource(questionAnswerId: string): void;
|
|
19
19
|
beginDelayedSelectSource(questionAnswerId: string): void;
|
|
20
20
|
cancelPendingSelectSource(questionAnswerId: string): void;
|
|
@@ -23,3 +23,4 @@ export interface SmartSnippetInteractiveQuestions {
|
|
|
23
23
|
* @internal
|
|
24
24
|
*/
|
|
25
25
|
export declare function buildSmartSnippetInteractiveQuestions(engine: SearchEngine, props?: SmartSnippetInteractiveQuestionsProps): SmartSnippetInteractiveQuestions;
|
|
26
|
+
export {};
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
2
2
|
import { type CoreSmartSnippetQuestionsList, type CoreSmartSnippetQuestionsListState, type SmartSnippetQuestionsListProps } from '../core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
|
|
3
3
|
import { type InlineLink } from '../smart-snippet/headless-smart-snippet-interactive-inline-links.js';
|
|
4
|
-
export type { QuestionAnswerDocumentIdentifier } from '../../api/search/search/question-answering.js';
|
|
5
4
|
export type { CoreSmartSnippetQuestionsList, CoreSmartSnippetQuestionsListState, SmartSnippetQuestionsListOptions, SmartSnippetQuestionsListProps, SmartSnippetRelatedQuestion, } from '../core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
|
|
6
5
|
/**
|
|
7
6
|
* A scoped and simplified part of the headless state that is relevant to the `SmartSnippetQuestionsList` controller.
|
|
@@ -2,7 +2,7 @@ import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
|
2
2
|
import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
|
|
3
3
|
import { type TabManager } from './headless-tab-manager.js';
|
|
4
4
|
export * from './headless-tab-manager.js';
|
|
5
|
-
|
|
5
|
+
interface TabManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, TabManager> {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
8
|
* Defines a `TabManager` controller instance.
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
2
|
-
import { type NotifyTrigger
|
|
3
|
-
export type { NotifyTrigger, NotifyTriggerState };
|
|
2
|
+
import { type NotifyTrigger } from '../core/triggers/headless-core-notify-trigger.js';
|
|
4
3
|
/**
|
|
5
4
|
* Creates a `NotifyTrigger` controller instance.
|
|
6
5
|
*
|
|
@@ -2,7 +2,6 @@ import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
|
2
2
|
import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
|
|
3
3
|
import type { NotifyTrigger } from '../core/triggers/headless-core-notify-trigger.js';
|
|
4
4
|
export type { NotifyTrigger, NotifyTriggerState, } from '../core/triggers/headless-core-notify-trigger.js';
|
|
5
|
-
export { buildNotifyTrigger } from './headless-notify-trigger.js';
|
|
6
5
|
export interface NotifyTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NotifyTrigger> {
|
|
7
6
|
}
|
|
8
7
|
/**
|
|
@@ -2,7 +2,6 @@ import type { SearchEngine } from '../../app/search-engine/search-engine.js';
|
|
|
2
2
|
import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
|
|
3
3
|
import type { RedirectionTrigger } from '../core/triggers/headless-core-redirection-trigger.js';
|
|
4
4
|
export type { RedirectionTrigger, RedirectionTriggerState, } from '../core/triggers/headless-core-redirection-trigger.js';
|
|
5
|
-
export { buildRedirectionTrigger } from './headless-redirection-trigger.js';
|
|
6
5
|
export interface RedirectionTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, RedirectionTrigger> {
|
|
7
6
|
}
|
|
8
7
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
type AdvancedSearchQueriesDefaultFiltersState = {
|
|
2
2
|
/**
|
|
3
3
|
* The initial cq filter (e.g., `((q AND aq) OR dq) AND cq).
|
|
4
4
|
*/
|
|
@@ -15,7 +15,7 @@ export interface AdvancedSearchQueriesDefaultFiltersState {
|
|
|
15
15
|
* The initial dq filter, or disjunction query expression filter (e.g., `((q AND aq) OR dq) AND cq).
|
|
16
16
|
*/
|
|
17
17
|
dq: string;
|
|
18
|
-
}
|
|
18
|
+
};
|
|
19
19
|
export interface AdvancedSearchQueriesState {
|
|
20
20
|
/**
|
|
21
21
|
* The cq filter (e.g., `((q AND aq) OR dq) AND cq).
|
|
@@ -68,3 +68,4 @@ export interface AdvancedSearchQueriesState {
|
|
|
68
68
|
defaultFilters: AdvancedSearchQueriesDefaultFiltersState;
|
|
69
69
|
}
|
|
70
70
|
export declare const getAdvancedSearchQueriesInitialState: () => AdvancedSearchQueriesState;
|
|
71
|
+
export {};
|
|
@@ -1,40 +1,7 @@
|
|
|
1
|
-
import type { SearchPageEvents as LegacySearchPageEvents } from 'coveo.analytics/dist/definitions/searchPage/searchPageEvents.js';
|
|
2
1
|
import type { Result } from '../../api/search/search/result.js';
|
|
3
2
|
import type { OmniboxSuggestionMetadata } from '../query-suggest/query-suggest-analytics-actions.js';
|
|
4
3
|
import type { SearchAction } from '../search/search-actions.js';
|
|
5
4
|
import { type ClickAction, type CustomAction, type LegacySearchAction } from './analytics-utils.js';
|
|
6
|
-
export interface SearchEventPayload {
|
|
7
|
-
/** The identifier of the search action (e.g., `interfaceLoad`). */
|
|
8
|
-
evt: LegacySearchPageEvents | string;
|
|
9
|
-
/** The event metadata. */
|
|
10
|
-
meta?: Record<string, unknown>;
|
|
11
|
-
}
|
|
12
|
-
export interface ClickEventPayload {
|
|
13
|
-
/**
|
|
14
|
-
* The identifier of the click action.
|
|
15
|
-
*/
|
|
16
|
-
evt: LegacySearchPageEvents | string;
|
|
17
|
-
/**
|
|
18
|
-
* The result associated with the click event.
|
|
19
|
-
*/
|
|
20
|
-
result: Result;
|
|
21
|
-
/**
|
|
22
|
-
* The event metadata.
|
|
23
|
-
*/
|
|
24
|
-
meta?: Record<string, unknown>;
|
|
25
|
-
}
|
|
26
|
-
export interface CustomEventPayload {
|
|
27
|
-
/**
|
|
28
|
-
* The event cause identifier of the custom action
|
|
29
|
-
*/
|
|
30
|
-
evt: LegacySearchPageEvents | string;
|
|
31
|
-
/**
|
|
32
|
-
* The event type identifier of the custom action
|
|
33
|
-
*/
|
|
34
|
-
type: string;
|
|
35
|
-
/** The event metadata. */
|
|
36
|
-
meta?: Record<string, unknown>;
|
|
37
|
-
}
|
|
38
5
|
export interface LogSearchEventActionCreatorPayload {
|
|
39
6
|
/**
|
|
40
7
|
* The identifier of the search action (e.g., `interfaceLoad`).
|
|
@@ -17,25 +17,25 @@ import type { ThunkExtraArguments } from '../../app/thunk-extra-arguments.js';
|
|
|
17
17
|
import type { RecommendationAppState } from '../../state/recommendation-app-state.js';
|
|
18
18
|
import type { SearchAppState } from '../../state/search-app-state.js';
|
|
19
19
|
import type { ConfigurationSection } from '../../state/state-sections.js';
|
|
20
|
-
|
|
20
|
+
type PreparableAnalyticsActionOptions<StateNeeded extends ConfigurationSection> = {
|
|
21
21
|
analyticsClientMiddleware: AnalyticsClientSendEventHook;
|
|
22
22
|
preprocessRequest: PreprocessRequest | undefined;
|
|
23
23
|
logger: Logger;
|
|
24
24
|
getState(): StateNeeded;
|
|
25
|
-
}
|
|
25
|
+
};
|
|
26
26
|
export type AnalyticsAsyncThunk<StateNeeded extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> = AsyncThunk<void, void, AsyncThunkAnalyticsOptions<StateNeeded>>;
|
|
27
27
|
export declare function makeBasicNewSearchAnalyticsAction(actionCause: string, getState: () => StateNeededBySearchAnalyticsProvider): {
|
|
28
28
|
actionCause: string;
|
|
29
29
|
type: string;
|
|
30
30
|
};
|
|
31
|
-
|
|
31
|
+
type PreparedAnalyticsAction<StateNeeded extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> = {
|
|
32
32
|
description?: EventDescription;
|
|
33
33
|
action: AnalyticsAsyncThunk<StateNeeded>;
|
|
34
|
-
}
|
|
34
|
+
};
|
|
35
35
|
type PrepareAnalyticsFunction<StateNeeded extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> = (options: PreparableAnalyticsActionOptions<StateNeeded>) => Promise<PreparedAnalyticsAction<StateNeeded>>;
|
|
36
|
-
|
|
36
|
+
type PreparableAnalyticsAction<StateNeeded extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> = AnalyticsAsyncThunk<StateNeeded> & {
|
|
37
37
|
prepare: PrepareAnalyticsFunction<StateNeeded>;
|
|
38
|
-
}
|
|
38
|
+
};
|
|
39
39
|
export type LegacySearchAction = PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
|
|
40
40
|
export type CustomAction = PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
|
|
41
41
|
export type ClickAction = PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
|
|
@@ -43,22 +43,18 @@ export type InstantResultsSearchAction = PreparableAnalyticsAction<StateNeededBy
|
|
|
43
43
|
export type InstantResultsClickAction = PreparableAnalyticsAction<StateNeededByInstantResultsAnalyticsProvider>;
|
|
44
44
|
export type InsightAction = PreparableAnalyticsAction<StateNeededByInsightAnalyticsProvider>;
|
|
45
45
|
export type CaseAssistAction = PreparableAnalyticsAction<StateNeededByCaseAssistAnalytics>;
|
|
46
|
-
|
|
46
|
+
type AsyncThunkAnalyticsOptions<T extends StateNeededBySearchAnalyticsProvider> = {
|
|
47
47
|
state: T;
|
|
48
48
|
extra: ThunkExtraArguments;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
state: T;
|
|
52
|
-
extra: ThunkExtraArguments;
|
|
53
|
-
}
|
|
54
|
-
export type AnalyticsActionOptions<LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider, StateNeeded extends StateNeededBySearchAnalyticsProvider, LegacyGetBuilderType, LegacyProvider, Client, PayloadType> = Omit<LegacyAnalyticsOptions<LegacyStateNeeded, Client, LegacyProvider>, '__legacy__getBuilder'> & Partial<NextAnalyticsOptions<StateNeeded, PayloadType>> & {
|
|
49
|
+
};
|
|
50
|
+
type AnalyticsActionOptions<LegacyStateNeeded extends StateNeededBySearchAnalyticsProvider, StateNeeded extends StateNeededBySearchAnalyticsProvider, LegacyGetBuilderType, LegacyProvider, Client, PayloadType> = Omit<LegacyAnalyticsOptions<LegacyStateNeeded, Client, LegacyProvider>, '__legacy__getBuilder'> & Partial<NextAnalyticsOptions<StateNeeded, PayloadType>> & {
|
|
55
51
|
__legacy__getBuilder: LegacyGetBuilderType;
|
|
56
52
|
};
|
|
57
|
-
|
|
53
|
+
interface NextAnalyticsOptions<StateNeeded extends InternalLegacyStateNeeded, PayloadType> {
|
|
58
54
|
analyticsType: string;
|
|
59
55
|
analyticsPayloadBuilder: (state: StateNeeded) => PayloadType;
|
|
60
56
|
}
|
|
61
|
-
|
|
57
|
+
interface LegacyAnalyticsOptions<StateNeeded extends InternalLegacyStateNeeded, Client, Provider> {
|
|
62
58
|
prefix: string;
|
|
63
59
|
__legacy__getBuilder: (client: Client, state: StateNeeded) => Promise<EventBuilder | null> | null;
|
|
64
60
|
__legacy__provider?: (getState: () => StateNeeded) => Provider;
|
|
@@ -77,8 +73,6 @@ export declare const makeInsightAnalyticsActionFactory: (actionCause: string) =>
|
|
|
77
73
|
<LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, ComputedLegacyAnalyticsOptions extends LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider> = LegacyAnalyticsOptions<LegacyStateNeeded, CoveoInsightClient, InsightAnalyticsProvider>>(prefix: string, __legacy__getBuilder: LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, __legacy__provider?: ComputedLegacyAnalyticsOptions["__legacy__provider"] | undefined): PreparableAnalyticsAction<LegacyStateNeeded>;
|
|
78
74
|
<LegacyStateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, StateNeeded extends StateNeededByInsightAnalyticsProvider = StateNeededByInsightAnalyticsProvider, PayloadType = {}>({ prefix, __legacy__getBuilder, __legacy__provider, analyticsPayloadBuilder, analyticsType, }: AnalyticsActionOptions<LegacyStateNeeded, StateNeeded, LogFunction<CoveoInsightClient, StateNeededByInsightAnalyticsProvider>, InsightAnalyticsProvider, CoveoInsightClient, PayloadType>): PreparableAnalyticsAction<StateNeeded>;
|
|
79
75
|
};
|
|
80
|
-
export declare const makeNoopAnalyticsAction: () => PreparableAnalyticsAction<StateNeededBySearchAnalyticsProvider>;
|
|
81
|
-
export declare const noopSearchAnalyticsAction: () => LegacySearchAction;
|
|
82
76
|
export declare const partialDocumentInformation: (result: Result, state: Partial<SearchAppState>) => PartialDocumentInformation;
|
|
83
77
|
export declare const partialRecommendationInformation: (result: Result, state: Partial<RecommendationAppState>) => PartialDocumentInformation;
|
|
84
78
|
export declare const partialCitationInformation: (citation: GeneratedAnswerCitation, state: Partial<SearchAppState>) => PartialDocumentInformation;
|
|
@@ -2,7 +2,6 @@ export declare enum LegacySearchPageEvents {
|
|
|
2
2
|
/**
|
|
3
3
|
* Identifies the custom event that gets logged when the Results per page component is selected.
|
|
4
4
|
*/
|
|
5
|
-
pagerResize = "pagerResize",
|
|
6
5
|
/**
|
|
7
6
|
* Identifies the custom event that gets logged when a page number is selected and more items are loaded.
|
|
8
7
|
*/
|
|
@@ -14,9 +13,5 @@ export declare enum LegacySearchPageEvents {
|
|
|
14
13
|
/**
|
|
15
14
|
* Identifies the custom event that gets logged when the Previous Page link is selected and more items are loaded.
|
|
16
15
|
*/
|
|
17
|
-
pagerPrevious = "pagerPrevious"
|
|
18
|
-
/**
|
|
19
|
-
* Identifies the custom event that gets logged when the user scrolls to the bottom of the item page and more results are loaded.
|
|
20
|
-
*/
|
|
21
|
-
pagerScrolling = "pagerScrolling"
|
|
16
|
+
pagerPrevious = "pagerPrevious"
|
|
22
17
|
}
|
|
@@ -9,12 +9,13 @@ export interface SetAttachedResultsActionCreatorPayload {
|
|
|
9
9
|
*/
|
|
10
10
|
loading?: boolean;
|
|
11
11
|
}
|
|
12
|
-
|
|
12
|
+
interface SetAttachToCaseAttachActionCreatorPayload {
|
|
13
13
|
result: AttachedResult;
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
interface SetAttachToCaseDetachActionCreatorPayload {
|
|
16
16
|
result: AttachedResult;
|
|
17
17
|
}
|
|
18
18
|
export declare const setAttachedResults: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachedResultsActionCreatorPayload], SetAttachedResultsActionCreatorPayload, "insight/attachToCase/setAttachedResults", never, never>;
|
|
19
19
|
export declare const attachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseAttachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/attach", never, never>;
|
|
20
20
|
export declare const detachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseDetachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/detach", never, never>;
|
|
21
|
+
export {};
|
|
@@ -1,3 +1,105 @@
|
|
|
1
1
|
import type { Result } from '../../api/search/search/result.js';
|
|
2
|
-
export declare const logCaseAttach: (result: Result) =>
|
|
3
|
-
|
|
2
|
+
export declare const logCaseAttach: (result: Result) => (() => import("@reduxjs/toolkit").AsyncThunkAction<void, void, {
|
|
3
|
+
state: import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
|
|
4
|
+
extra: import("../../app/thunk-extra-arguments.js").ThunkExtraArguments;
|
|
5
|
+
}>) & {
|
|
6
|
+
pending: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[string, void, unknown?], undefined, string, never, {
|
|
7
|
+
arg: void;
|
|
8
|
+
requestId: string;
|
|
9
|
+
requestStatus: "pending";
|
|
10
|
+
}>;
|
|
11
|
+
rejected: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Error | null, string, void, unknown?, unknown?], unknown, string, import("@reduxjs/toolkit").SerializedError, {
|
|
12
|
+
arg: void;
|
|
13
|
+
requestId: string;
|
|
14
|
+
requestStatus: "rejected";
|
|
15
|
+
aborted: boolean;
|
|
16
|
+
condition: boolean;
|
|
17
|
+
} & ({
|
|
18
|
+
rejectedWithValue: true;
|
|
19
|
+
} | ({
|
|
20
|
+
rejectedWithValue: false;
|
|
21
|
+
} & {}))>;
|
|
22
|
+
fulfilled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[void, string, void, unknown?], void, string, never, {
|
|
23
|
+
arg: void;
|
|
24
|
+
requestId: string;
|
|
25
|
+
requestStatus: "fulfilled";
|
|
26
|
+
}>;
|
|
27
|
+
settled: (action: any) => action is import("@reduxjs/toolkit").PayloadAction<void, string, {
|
|
28
|
+
arg: void;
|
|
29
|
+
requestId: string;
|
|
30
|
+
requestStatus: "fulfilled";
|
|
31
|
+
}, never> | import("@reduxjs/toolkit").PayloadAction<unknown, string, {
|
|
32
|
+
arg: void;
|
|
33
|
+
requestId: string;
|
|
34
|
+
requestStatus: "rejected";
|
|
35
|
+
aborted: boolean;
|
|
36
|
+
condition: boolean;
|
|
37
|
+
} & ({
|
|
38
|
+
rejectedWithValue: true;
|
|
39
|
+
} | ({
|
|
40
|
+
rejectedWithValue: false;
|
|
41
|
+
} & {})), import("@reduxjs/toolkit").SerializedError>;
|
|
42
|
+
typePrefix: string;
|
|
43
|
+
} & {
|
|
44
|
+
prepare: (options: {
|
|
45
|
+
analyticsClientMiddleware: import("coveo.analytics").AnalyticsClientSendEventHook;
|
|
46
|
+
preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
|
|
47
|
+
logger: import("pino").Logger;
|
|
48
|
+
getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
|
|
49
|
+
}) => Promise<{
|
|
50
|
+
description?: import("coveo.analytics").EventDescription;
|
|
51
|
+
action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
|
|
52
|
+
}>;
|
|
53
|
+
};
|
|
54
|
+
export declare const logCaseDetach: (result: Result) => (() => import("@reduxjs/toolkit").AsyncThunkAction<void, void, {
|
|
55
|
+
state: import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
|
|
56
|
+
extra: import("../../app/thunk-extra-arguments.js").ThunkExtraArguments;
|
|
57
|
+
}>) & {
|
|
58
|
+
pending: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[string, void, unknown?], undefined, string, never, {
|
|
59
|
+
arg: void;
|
|
60
|
+
requestId: string;
|
|
61
|
+
requestStatus: "pending";
|
|
62
|
+
}>;
|
|
63
|
+
rejected: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Error | null, string, void, unknown?, unknown?], unknown, string, import("@reduxjs/toolkit").SerializedError, {
|
|
64
|
+
arg: void;
|
|
65
|
+
requestId: string;
|
|
66
|
+
requestStatus: "rejected";
|
|
67
|
+
aborted: boolean;
|
|
68
|
+
condition: boolean;
|
|
69
|
+
} & ({
|
|
70
|
+
rejectedWithValue: true;
|
|
71
|
+
} | ({
|
|
72
|
+
rejectedWithValue: false;
|
|
73
|
+
} & {}))>;
|
|
74
|
+
fulfilled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[void, string, void, unknown?], void, string, never, {
|
|
75
|
+
arg: void;
|
|
76
|
+
requestId: string;
|
|
77
|
+
requestStatus: "fulfilled";
|
|
78
|
+
}>;
|
|
79
|
+
settled: (action: any) => action is import("@reduxjs/toolkit").PayloadAction<void, string, {
|
|
80
|
+
arg: void;
|
|
81
|
+
requestId: string;
|
|
82
|
+
requestStatus: "fulfilled";
|
|
83
|
+
}, never> | import("@reduxjs/toolkit").PayloadAction<unknown, string, {
|
|
84
|
+
arg: void;
|
|
85
|
+
requestId: string;
|
|
86
|
+
requestStatus: "rejected";
|
|
87
|
+
aborted: boolean;
|
|
88
|
+
condition: boolean;
|
|
89
|
+
} & ({
|
|
90
|
+
rejectedWithValue: true;
|
|
91
|
+
} | ({
|
|
92
|
+
rejectedWithValue: false;
|
|
93
|
+
} & {})), import("@reduxjs/toolkit").SerializedError>;
|
|
94
|
+
typePrefix: string;
|
|
95
|
+
} & {
|
|
96
|
+
prepare: (options: {
|
|
97
|
+
analyticsClientMiddleware: import("coveo.analytics").AnalyticsClientSendEventHook;
|
|
98
|
+
preprocessRequest: import("../../api/preprocess-request.js").PreprocessRequest | undefined;
|
|
99
|
+
logger: import("pino").Logger;
|
|
100
|
+
getState(): import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider;
|
|
101
|
+
}) => Promise<{
|
|
102
|
+
description?: import("coveo.analytics").EventDescription;
|
|
103
|
+
action: import("../analytics/analytics-utils.js").AnalyticsAsyncThunk<import("../../api/analytics/insight-analytics.js").StateNeededByInsightAnalyticsProvider>;
|
|
104
|
+
}>;
|
|
105
|
+
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface SetCaseAssistConfigurationActionCreatorPayload {
|
|
2
2
|
/**
|
|
3
3
|
* The unique identifier of the target case assist configuration. See [Retrieving a Case Assist ID](https://docs.coveo.com/en/3328/service/manage-case-assist-configurations#retrieving-a-case-assist-id).
|
|
4
4
|
*/
|
|
@@ -18,3 +18,4 @@ export interface SetCaseAssistConfigurationActionCreatorPayload {
|
|
|
18
18
|
proxyBaseUrl?: string;
|
|
19
19
|
}
|
|
20
20
|
export declare const setCaseAssistConfiguration: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetCaseAssistConfigurationActionCreatorPayload], SetCaseAssistConfigurationActionCreatorPayload, "caseAssistConfiguration/set", never, never>;
|
|
21
|
+
export {};
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { GetCaseClassificationsRequest } from '../../api/service/case-assist/get-case-classifications/get-case-classifications-request.js';
|
|
2
1
|
import type { GetCaseClassificationsResponse } from '../../api/service/case-assist/get-case-classifications/get-case-classifications-response.js';
|
|
3
2
|
import type { CaseAssistConfigurationSection, CaseFieldSection, CaseInputSection, ConfigurationSection, DebugSection } from '../../state/state-sections.js';
|
|
4
3
|
export interface SetCaseFieldActionCreatorPayload {
|
|
@@ -28,4 +27,3 @@ export declare const fetchCaseClassifications: import("@reduxjs/toolkit").AsyncT
|
|
|
28
27
|
fulfilledMeta?: unknown;
|
|
29
28
|
rejectedMeta?: unknown;
|
|
30
29
|
}>;
|
|
31
|
-
export declare const buildFetchClassificationRequest: (state: StateNeededByFetchClassifications) => Promise<GetCaseClassificationsRequest>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CaseAssistAPIErrorStatusResponse } from '../../api/service/case-assist/case-assist-api-client.js';
|
|
2
2
|
export declare const getCaseFieldInitialState: () => CaseFieldState;
|
|
3
|
-
|
|
3
|
+
interface CaseFieldStatus {
|
|
4
4
|
/**
|
|
5
5
|
* `true` if a request is in progress and `false` otherwise.
|
|
6
6
|
*/
|
|
@@ -28,7 +28,7 @@ export interface CaseFieldSuggestion {
|
|
|
28
28
|
*/
|
|
29
29
|
confidence: number;
|
|
30
30
|
}
|
|
31
|
-
|
|
31
|
+
interface CaseField {
|
|
32
32
|
/**
|
|
33
33
|
* The field to predict.
|
|
34
34
|
*/
|
|
@@ -50,3 +50,4 @@ export interface CaseFieldState {
|
|
|
50
50
|
[fieldName: string]: CaseField;
|
|
51
51
|
};
|
|
52
52
|
}
|
|
53
|
+
export {};
|
|
@@ -4,7 +4,6 @@ import type { CategoryFacetSearchResponse } from '../../../../api/search/facet-s
|
|
|
4
4
|
import type { SpecificFacetSearchResponse } from '../../../../api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
|
|
5
5
|
import type { ClientThunkExtraArguments } from '../../../../app/thunk-extra-arguments.js';
|
|
6
6
|
import type { StateNeededForAnyFacetSearch } from './commerce-facet-search-state.js';
|
|
7
|
-
import type { StateNeededForRegularFacetSearch } from './regular/commerce-regular-facet-search-state.js';
|
|
8
7
|
type ExecuteCommerceFacetSearchThunkReturn = {
|
|
9
8
|
facetId: string;
|
|
10
9
|
response: CommerceAPIResponse<SpecificFacetSearchResponse | CategoryFacetSearchResponse>;
|
|
@@ -33,8 +32,6 @@ export declare const executeCommerceFieldSuggest: import("@reduxjs/toolkit").Asy
|
|
|
33
32
|
fulfilledMeta?: unknown;
|
|
34
33
|
rejectedMeta?: unknown;
|
|
35
34
|
}>;
|
|
36
|
-
export declare const isRegularFacetSearchState: (s: StateNeededForAnyFacetSearch, facetId: string) => s is StateNeededForRegularFacetSearch;
|
|
37
|
-
export declare const isRegularFieldSuggestionsState: (s: StateNeededForAnyFacetSearch, facetId: string) => s is StateNeededForRegularFacetSearch;
|
|
38
35
|
export declare function getFacetIdWithoutCommerceFieldSuggestionNamespace(facetId: string): string;
|
|
39
36
|
export declare function getFacetIdWithCommerceFieldSuggestionNamespace(facetId: string): string;
|
|
40
37
|
export {};
|
|
@@ -9,5 +9,4 @@ export declare function buildSelectedFacetValueRequest(rawValue: string): {
|
|
|
9
9
|
value: string;
|
|
10
10
|
};
|
|
11
11
|
export declare function selectPath(request: CategoryFacetRequest, path: string[], initialNumberOfValues?: number): void;
|
|
12
|
-
export declare function buildCurrentValuesFromPath(path: string[]): CategoryFacetValueRequest[];
|
|
13
12
|
export declare function buildCategoryFacetValueRequest(value: string): CategoryFacetValueRequest;
|
|
@@ -2,7 +2,7 @@ import type { DateRangeRequest, NumericRangeRequest } from '../../../../../contr
|
|
|
2
2
|
import type { BaseFacetValueRequest } from '../../../../facets/facet-api/request.js';
|
|
3
3
|
import type { FacetRequest, FacetValueRequest } from '../../../../facets/facet-set/interfaces/request.js';
|
|
4
4
|
import type { CategoryFacetDelimitingCharacter, FacetType, NumericFacetExtraProperties } from './common.js';
|
|
5
|
-
|
|
5
|
+
type FreezableFacetRequestProperties = {
|
|
6
6
|
preventAutoSelect: boolean;
|
|
7
7
|
freezeCurrentValues?: boolean;
|
|
8
8
|
};
|
|
@@ -18,7 +18,7 @@ export type NumericFacetRequest = BaseCommerceFacetRequest<NumericRangeRequest,
|
|
|
18
18
|
export type RegularFacetRequest = BaseCommerceFacetRequest<FacetValueRequest, 'regular'> & FreezableFacetRequestProperties;
|
|
19
19
|
export type LocationFacetValueRequest = FacetValueRequest;
|
|
20
20
|
export type LocationFacetRequest = BaseCommerceFacetRequest<LocationFacetValueRequest, 'location'>;
|
|
21
|
-
|
|
21
|
+
type BaseCommerceFacetRequest<Value, Type extends FacetType> = Pick<FacetRequest, 'facetId' | 'field' | 'isFieldExpanded'> & {
|
|
22
22
|
displayName?: string;
|
|
23
23
|
type: Type;
|
|
24
24
|
values: Value[];
|
|
@@ -27,8 +27,4 @@ export type BaseCommerceFacetRequest<Value, Type extends FacetType> = Pick<Facet
|
|
|
27
27
|
};
|
|
28
28
|
export type AnyFacetValueRequest = FacetValueRequest | LocationFacetValueRequest | CategoryFacetValueRequest | NumericRangeRequest | DateRangeRequest;
|
|
29
29
|
export type AnyFacetRequest = BaseCommerceFacetRequest<AnyFacetValueRequest, FacetType> & Partial<CategoryFacetDelimitingCharacter & NumericFacetExtraProperties & FreezableFacetRequestProperties>;
|
|
30
|
-
type MappedFacetRequest = {
|
|
31
|
-
[T in FacetType]: T extends 'numericalRange' ? NumericFacetRequest : T extends 'regular' ? RegularFacetRequest : T extends 'dateRange' ? DateFacetRequest : T extends 'hierarchical' ? CategoryFacetRequest : never;
|
|
32
|
-
};
|
|
33
|
-
export type CommerceFacetRequest = MappedFacetRequest[FacetType];
|
|
34
30
|
export {};
|
|
@@ -29,7 +29,7 @@ export type LocationFacetResponse = BaseFacetResponse<LocationFacetValue, 'locat
|
|
|
29
29
|
export interface LocationFacetValue extends BaseFacetValue {
|
|
30
30
|
value: string;
|
|
31
31
|
}
|
|
32
|
-
|
|
32
|
+
interface RangeFacetValue<T> extends BaseFacetValue, NonLocationFacetValue {
|
|
33
33
|
start: T;
|
|
34
34
|
end: T;
|
|
35
35
|
endInclusive: boolean;
|
|
@@ -38,7 +38,7 @@ export interface RangeFacetValue<T> extends BaseFacetValue, NonLocationFacetValu
|
|
|
38
38
|
*/
|
|
39
39
|
moreValuesAvailable: boolean;
|
|
40
40
|
}
|
|
41
|
-
|
|
41
|
+
interface BaseFacetResponse<Value extends BaseFacetValue, Type extends FacetType> {
|
|
42
42
|
facetId: string;
|
|
43
43
|
field: string;
|
|
44
44
|
displayName: string;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { NumericRangeRequest } from '../../../facets/range-facets/numeric-facet-set/interfaces/request.js';
|
|
2
|
-
|
|
2
|
+
interface ManualNumericFacetSetSlice {
|
|
3
3
|
manualRange: NumericRangeRequest | undefined;
|
|
4
4
|
}
|
|
5
5
|
export type ManualNumericFacetSetState = Record<string, ManualNumericFacetSetSlice>;
|
|
6
6
|
export declare function getManualNumericFacetInitialState(): ManualNumericFacetSetState;
|
|
7
|
+
export {};
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
|
|
2
2
|
import type { stateKey } from '../../../app/state-key.js';
|
|
3
3
|
import type { Parameters as ManagedParameters } from './parameters-actions.js';
|
|
4
|
-
export declare function initialParametersSelector(state: CommerceEngine[typeof stateKey]): Required<ManagedParameters>;
|
|
5
4
|
export declare function activeParametersSelector(state: CommerceEngine[typeof stateKey]): ManagedParameters;
|
|
@@ -1,11 +1,5 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import { type SearchParamValue as CommerceSearchParamValue, type FacetValueSearchParam } from '../../search-parameters/search-parameter-utils.js';
|
|
1
|
+
import { type SearchParamValue as CommerceSearchParamValue } from '../../search-parameters/search-parameter-utils.js';
|
|
3
2
|
import type { CommerceSearchParameters } from '../search-parameters/search-parameters-actions.js';
|
|
4
|
-
import type { SortCriterion } from '../sort/sort.js';
|
|
5
|
-
import { type FacetParameters } from './parameters-serializer.js';
|
|
6
|
-
type CommerceSearchParametersKey = keyof CommerceSearchParameters;
|
|
7
|
-
type CommerceSearchParamPair<T> = [CommerceSearchParametersKey, T];
|
|
8
|
-
type RangeFacetValueSearchParam = Record<string, DateRangeRequest[] | NumericRangeRequest[]>;
|
|
9
3
|
export declare function buildParameterSerializer(): {
|
|
10
4
|
deserialize: typeof deserialize;
|
|
11
5
|
serialize: typeof serialize;
|
|
@@ -25,20 +19,4 @@ declare function deserialize(urlCommerceSearchParams: URLSearchParams | Record<s
|
|
|
25
19
|
* @returns The serialized URL.
|
|
26
20
|
*/
|
|
27
21
|
declare function serialize(commerceSearchParameters: CommerceSearchParameters, initialUrl: URL): string;
|
|
28
|
-
export declare function isValidKey(key: string): key is CommerceSearchParametersKey;
|
|
29
|
-
export declare function isValidBasicKey(key: string): key is Exclude<CommerceSearchParametersKey, keyof FacetParameters>;
|
|
30
|
-
/**
|
|
31
|
-
* Extends the search parameters with the given key-value pair. If the key-value pair is not valid or if the value is undefined, the search parameters are not modified.
|
|
32
|
-
* @param commerceSearchParams - The search parameters object to extend.
|
|
33
|
-
* @param key - The key of the search parameter.
|
|
34
|
-
* @param value - The value of the search parameter.
|
|
35
|
-
*/
|
|
36
|
-
export declare function extendSearchParams(commerceSearchParams: Record<string, unknown>, key: string, value: CommerceSearchParamValue): void;
|
|
37
|
-
export declare function cast<K extends CommerceSearchParametersKey>(pair: [K, string], decode?: boolean): [K, unknown];
|
|
38
|
-
export declare function isValidSearchParam(key: string): boolean;
|
|
39
|
-
export declare function isSortPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<SortCriterion>;
|
|
40
|
-
export declare function isFacetPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<FacetValueSearchParam>;
|
|
41
|
-
export declare function isRangeFacetPair(pair: [CommerceSearchParametersKey, unknown]): pair is CommerceSearchParamPair<RangeFacetValueSearchParam>;
|
|
42
|
-
export declare function isRangeFacetObject(obj: unknown): obj is Record<string, (DateRangeRequest | NumericRangeRequest)[]>;
|
|
43
|
-
export declare function addFacetValuesToSearchParams(facetId: string, paramKey: CommerceSearchParametersKey): (searchParams: Record<string, unknown>, valueArray: unknown[]) => void;
|
|
44
22
|
export {};
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { RecordValue } from '@coveo/bueno';
|
|
2
1
|
import type { ChildProduct } from '../../../api/commerce/common/product.js';
|
|
3
2
|
import type { CommerceSuccessResponse } from '../../../api/commerce/common/response.js';
|
|
4
3
|
import type { ProductListingSection } from '../../../state/state-sections.js';
|
|
@@ -31,7 +30,4 @@ export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<Qu
|
|
|
31
30
|
export interface PromoteChildToParentPayload {
|
|
32
31
|
child: ChildProduct;
|
|
33
32
|
}
|
|
34
|
-
export declare const promoteChildToParentDefinition: {
|
|
35
|
-
child: RecordValue;
|
|
36
|
-
};
|
|
37
33
|
export declare const promoteChildToParent: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: PromoteChildToParentPayload], PromoteChildToParentPayload, "commerce/productListing/promoteChildToParent", never, never>;
|