@coveo/quantic 3.43.2 → 3.43.4
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/lwc/quanticBreadcrumbManager/e2e/data.ts +130 -0
- package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/fixture.ts +25 -14
- package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/quanticBreadcrumbManager.e2e.ts +57 -16
- package/force-app/main/default/lwc/quanticCardContainer/quanticCardContainer.css +3 -4
- package/force-app/main/default/lwc/quanticCardContainer/quanticCardContainer.html +1 -1
- package/force-app/main/default/lwc/quanticCarousel/quanticCarousel.css +5 -5
- package/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.css +3 -3
- package/force-app/main/default/lwc/quanticCategoryFacet/e2e/data.ts +70 -6
- package/force-app/main/default/lwc/quanticCategoryFacet/e2e/fixture.ts +17 -13
- package/force-app/main/default/lwc/quanticCategoryFacet/e2e/quanticCategoryFacet.e2e.ts +34 -14
- package/force-app/main/default/lwc/quanticCategoryFacet/quanticCategoryFacet.css +1 -1
- package/force-app/main/default/lwc/quanticCitation/quanticCitation.css +12 -11
- package/force-app/main/default/lwc/quanticDateFacet/e2e/data.ts +24 -4
- package/force-app/main/default/lwc/quanticDateFacet/e2e/fixture.ts +17 -13
- package/force-app/main/default/lwc/quanticDateFacet/e2e/quanticDateFacet.e2e.ts +26 -4
- package/force-app/main/default/lwc/quanticDidYouMean/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.css +2 -2
- package/force-app/main/default/lwc/quanticFacet/e2e/data.ts +50 -9
- package/force-app/main/default/lwc/quanticFacet/e2e/fixture.ts +18 -13
- package/force-app/main/default/lwc/quanticFacet/e2e/quanticFacet.e2e.ts +43 -9
- package/force-app/main/default/lwc/quanticFacet/quanticFacet.css +1 -1
- package/force-app/main/default/lwc/quanticFacetManager/e2e/data.ts +59 -0
- package/force-app/main/default/lwc/quanticFacetManager/e2e/fixture.ts +26 -15
- package/force-app/main/default/lwc/quanticFacetManager/e2e/quanticFacetManager.e2e.ts +7 -7
- package/force-app/main/default/lwc/quanticFacetStyles/quanticFacetStyles.css +10 -10
- package/force-app/main/default/lwc/quanticFeedbackModalQna/templates/quanticFeedbackModalQna.css +1 -1
- package/force-app/main/default/lwc/quanticFoldedResultList/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/agentData.ts +32 -1
- package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/pageObject.ts +6 -0
- package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/quanticGeneratedAnswerAgent.e2e.ts +66 -1
- package/force-app/main/default/lwc/quanticGeneratedAnswer/quanticGeneratedAnswer.css +1 -1
- package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.css +3 -3
- package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.html +3 -3
- package/force-app/main/default/lwc/quanticGeneratedAnswerBody/__tests__/quanticGeneratedAnswerBody.test.js +39 -0
- package/force-app/main/default/lwc/quanticGeneratedAnswerBody/quanticGeneratedAnswerBody.js +4 -1
- package/force-app/main/default/lwc/quanticGeneratedAnswerContent/templates/generatedMarkdownContent.css +21 -21
- package/force-app/main/default/lwc/quanticGeneratedAnswerContent/templates/generatedTextContent.css +2 -2
- package/force-app/main/default/lwc/quanticGeneratedAnswerFollowUpInput/quanticGeneratedAnswerFollowUpInput.css +9 -9
- package/force-app/main/default/lwc/quanticGeneratedAnswerStreamOfThought/quanticGeneratedAnswerStreamOfThought.css +2 -2
- package/force-app/main/default/lwc/quanticGeneratedAnswerThread/quanticGeneratedAnswerThread.css +8 -8
- package/force-app/main/default/lwc/quanticInsightSummary/quanticInsightSummary.css +2 -1
- package/force-app/main/default/lwc/quanticModal/quanticModal.css +3 -3
- package/force-app/main/default/lwc/quanticNotifications/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticNotifications/quanticNotifications.css +2 -2
- package/force-app/main/default/lwc/quanticNumericFacet/e2e/data.ts +24 -4
- package/force-app/main/default/lwc/quanticNumericFacet/e2e/fixture.ts +17 -13
- package/force-app/main/default/lwc/quanticNumericFacet/e2e/quanticNumericFacet.e2e.ts +28 -6
- package/force-app/main/default/lwc/quanticPager/e2e/fixture.ts +3 -3
- package/force-app/main/default/lwc/quanticPager/e2e/quanticPager.e2e.ts +1 -1
- package/force-app/main/default/lwc/quanticPill/quanticPill.css +2 -2
- package/force-app/main/default/lwc/quanticPlaceholder/quanticPlaceholder.css +2 -6
- package/force-app/main/default/lwc/quanticPlaceholder/quanticPlaceholder.html +1 -1
- package/force-app/main/default/lwc/quanticRadioButtonsGroup/quanticRadioButtonsGroup.css +9 -9
- package/force-app/main/default/lwc/quanticRecentQueriesList/e2e/fixture.ts +1 -0
- package/force-app/main/default/lwc/quanticRecentQueriesList/quanticRecentQueriesList.css +3 -7
- package/force-app/main/default/lwc/quanticRecentQueriesList/quanticRecentQueriesList.html +1 -1
- package/force-app/main/default/lwc/quanticRecentResultsList/e2e/fixture.ts +1 -0
- package/force-app/main/default/lwc/quanticRecentResultsList/quanticRecentResultsList.css +2 -6
- package/force-app/main/default/lwc/quanticRecentResultsList/quanticRecentResultsList.html +1 -1
- package/force-app/main/default/lwc/quanticRecommendationList/e2e/fixture.ts +1 -0
- package/force-app/main/default/lwc/quanticRecommendationList/quanticRecommendationList.css +1 -1
- package/force-app/main/default/lwc/quanticRefineToggle/quanticRefineToggle.css +4 -4
- package/force-app/main/default/lwc/quanticResultActionStyles/quanticResultActionStyles.css +2 -2
- package/force-app/main/default/lwc/quanticResultCopyToClipboard/e2e/fixture.ts +5 -2
- package/force-app/main/default/lwc/quanticResultLink/quanticResultLink.css +1 -1
- package/force-app/main/default/lwc/quanticResultList/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticResultPrintableUri/quanticResultPrintableUri.css +1 -1
- package/force-app/main/default/lwc/quanticResultQuickview/e2e/fixture.ts +7 -3
- package/force-app/main/default/lwc/quanticResultQuickview/quanticResultQuickview.css +6 -6
- package/force-app/main/default/lwc/quanticResultTag/quanticResultTag.css +2 -0
- package/force-app/main/default/lwc/quanticResultTemplate/quanticResultTemplate.css +1 -1
- package/force-app/main/default/lwc/quanticResultsPerPage/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticSearchBox/e2e/fixture.ts +3 -1
- package/force-app/main/default/lwc/quanticSearchBoxInput/templates/defaultSearchBoxInput.css +1 -1
- package/force-app/main/default/lwc/quanticSearchBoxInput/templates/expandableSearchBoxInput.css +4 -12
- package/force-app/main/default/lwc/quanticSearchBoxInput/templates/expandableSearchBoxInput.html +2 -2
- package/force-app/main/default/lwc/quanticSearchBoxSuggestionsList/e2e/fixture.ts +3 -0
- package/force-app/main/default/lwc/quanticSmartSnippet/e2e/fixture.ts +6 -4
- package/force-app/main/default/lwc/quanticSmartSnippetSource/quanticSmartSnippetSource.css +1 -1
- package/force-app/main/default/lwc/quanticSmartSnippetSuggestions/e2e/fixture.ts +6 -4
- package/force-app/main/default/lwc/quanticSort/e2e/fixture.ts +3 -2
- package/force-app/main/default/lwc/quanticSort/quanticSort.css +3 -3
- package/force-app/main/default/lwc/quanticSourceCitations/quanticSourceCitations.css +1 -1
- package/force-app/main/default/lwc/quanticStandaloneSearchBox/e2e/fixture.ts +2 -1
- package/force-app/main/default/lwc/quanticStatefulButton/quanticStatefulButton.css +2 -2
- package/force-app/main/default/lwc/quanticTab/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticTabBar/e2e/fixture.ts +6 -2
- package/force-app/main/default/lwc/quanticTabBar/e2e/quanticTabBar.e2e.ts +3 -2
- package/force-app/main/default/lwc/quanticThreadItem/__tests__/quanticThreadItem.test.js +138 -0
- package/force-app/main/default/lwc/quanticThreadItem/quanticThreadItem.css +27 -6
- package/force-app/main/default/lwc/quanticThreadItem/quanticThreadItem.html +10 -2
- package/force-app/main/default/lwc/quanticThreadItem/quanticThreadItem.js +37 -1
- package/force-app/main/default/lwc/quanticTimeframeFacet/e2e/data.ts +66 -0
- package/force-app/main/default/lwc/quanticTimeframeFacet/e2e/fixture.ts +20 -4
- package/force-app/main/default/lwc/quanticTimeframeFacet/e2e/quanticTimeframeFacet.e2e.ts +24 -0
- package/force-app/main/default/lwc/quanticTimeframeFacet/quanticTimeframeFacet.css +1 -1
- package/force-app/main/default/lwc/quanticTooltip/quanticTooltip.css +3 -3
- package/force-app/main/default/lwc/quanticUserAction/quanticUserAction.css +7 -7
- package/force-app/main/default/lwc/quanticUserActionsSession/quanticUserActionsSession.css +3 -3
- package/force-app/main/default/lwc/quanticUserActionsTimeline/templates/userActionsTimeline.css +2 -2
- package/force-app/main/default/lwc/searchBoxStyle/searchBoxStyle.css +10 -10
- package/force-app/main/default/staticresources/coveobueno/browser/bueno.js +1 -3
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +17 -17
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/case-assist-analytics.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/insight-analytics.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/engine-configuration.d.ts +34 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-engine/insight-engine.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-thunk-extra-arguments.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-thunk-extra-arguments.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/thunk-extra-arguments.d.ts +9 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/case-assist.index.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sort/headless-core-commerce-sort.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/url-manager/headless-core-url-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/headless-search.d.ts +1 -1
- 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 +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facet-manager/headless-core-facet-manager.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +0 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.d.ts +1 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-generated-answer.d.ts +1 -25
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-searchapi-generated-answer.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/pager/headless-core-pager.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/query-error/headless-core-query-error.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/recent-queries-list/headless-core-recent-queries-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/result-list/headless-core-result-list.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/status/headless-core-status.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/tab/headless-core-tab.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-query-trigger.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/document-suggestion-list/case-assist-headless-interactive-result.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/category-facet/headless-category-facet.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/facet/headless-facet.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-interactive-citation.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/history-manager/headless-history-manager.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facet-conditions-manager/headless-facet-conditions-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/generated-answer/headless-insight-interactive-citation.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/result-list/headless-insight-interactive-result.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/results-per-page/headless-insight-results-per-page.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-generated-answer-with-follow-ups.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/pager/headless-pager.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts +1 -2
- 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/recommendation/headless-recommendation.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/result-list/headless-recommendation-interactive-result.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-interactive-result.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-result-list.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/results-per-page/headless-results-per-page.d.ts +1 -1
- 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/sort/headless-sort.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/url-manager/headless-url-manager.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +1 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions.d.ts +4 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/cart/cart-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/context-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/category-facet/category-facet-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/folding/insight-folding-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-client.d.ts +38 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-insight-analytics-actions.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-search/insight-query-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-search/insight-search-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-set/query-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/result/result-insight-analytics-actions.d.ts +1 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts +7 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/recommendation.index.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next.index.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr.index.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/headless.js +17 -17
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +16 -16
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +16 -16
- package/package.json +4 -4
|
@@ -13,6 +13,7 @@ interface ConfigureCaseAssistAnalyticsOptions {
|
|
|
13
13
|
analyticsClientMiddleware?: AnalyticsClientSendEventHook;
|
|
14
14
|
preprocessRequest?: PreprocessRequest;
|
|
15
15
|
provider?: CaseAssistClientProvider;
|
|
16
|
+
disableBrowserPrivacySignals?: boolean;
|
|
16
17
|
}
|
|
17
|
-
export declare const configureCaseAssistAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: ConfigureCaseAssistAnalyticsOptions) => CaseAssistClient;
|
|
18
|
+
export declare const configureCaseAssistAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: ConfigureCaseAssistAnalyticsOptions) => CaseAssistClient;
|
|
18
19
|
export {};
|
|
@@ -27,6 +27,7 @@ interface ConfigureInsightAnalyticsOptions {
|
|
|
27
27
|
preprocessRequest?: PreprocessRequest;
|
|
28
28
|
provider?: InsightClientProvider;
|
|
29
29
|
getState(): StateNeededByInsightAnalyticsProvider;
|
|
30
|
+
disableBrowserPrivacySignals?: boolean;
|
|
30
31
|
}
|
|
31
|
-
export declare const configureInsightAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: ConfigureInsightAnalyticsOptions) => CoveoInsightClient;
|
|
32
|
+
export declare const configureInsightAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: ConfigureInsightAnalyticsOptions) => CoveoInsightClient;
|
|
32
33
|
export {};
|
|
@@ -96,8 +96,9 @@ interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = S
|
|
|
96
96
|
preprocessRequest?: PreprocessRequest;
|
|
97
97
|
provider?: SearchPageClientProvider;
|
|
98
98
|
getState(): State;
|
|
99
|
+
disableBrowserPrivacySignals?: boolean;
|
|
99
100
|
}
|
|
100
|
-
export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
|
|
101
|
+
export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, disableBrowserPrivacySignals, }: LegacyConfigureAnalyticsOptions<State> & {
|
|
101
102
|
provider: SearchPageClientProvider;
|
|
102
103
|
}) => CoveoSearchPageClient;
|
|
103
104
|
export declare const getPageID: () => string;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
|
|
2
|
+
import type { GeneratedAnswerAnalyticsClient } from '../../features/generated-answer/generated-answer-analytics-client.js';
|
|
2
3
|
import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
|
|
3
4
|
import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
|
|
4
5
|
import type { GeneratedAnswerStream } from './generated-answer-stream.js';
|
|
5
6
|
import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
|
|
6
|
-
export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction
|
|
7
|
+
export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>, generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient) => void;
|
|
7
8
|
export declare const buildAnswerEndpoint: (platformEndpoint: string, organizationId: string, answerConfigurationId: string, insightId?: string) => string;
|
|
8
9
|
export declare const answerApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
|
|
9
10
|
getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<AnswerApiQueryParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer", unknown>;
|
|
@@ -138,6 +138,40 @@ export interface AnalyticsConfiguration {
|
|
|
138
138
|
* See [Headless proxy: Analytics](https://docs.coveo.com/en/headless/latest/usage/proxy#analytics).
|
|
139
139
|
*/
|
|
140
140
|
proxyBaseUrl?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Whether to stop honoring browser privacy signals — Do Not Track (DNT) and
|
|
143
|
+
* Global Privacy Control (GPC) — when deciding whether to send **legacy**
|
|
144
|
+
* analytics (`analyticsMode: 'legacy'`).
|
|
145
|
+
*
|
|
146
|
+
* By default (`false`), Coveo libraries honor these signals: when the browser
|
|
147
|
+
* presents DNT or GPC, legacy analytics is automatically disabled. Setting this
|
|
148
|
+
* option to `true` is a deliberate choice that you configure in your own
|
|
149
|
+
* application code; legacy analytics events are then sent even when the browser
|
|
150
|
+
* presents a DNT or GPC signal.
|
|
151
|
+
*
|
|
152
|
+
* Coveo honors these signals by default and cannot determine whether overriding
|
|
153
|
+
* them is appropriate for your use case. If you enable this option, you are
|
|
154
|
+
* responsible for ensuring that doing so complies with the privacy laws and
|
|
155
|
+
* obligations that apply to you. Note that GPC is legally recognized as a valid
|
|
156
|
+
* opt-out mechanism in some jurisdictions (for example, under the California
|
|
157
|
+
* Consumer Privacy Act (CCPA) as amended by the California Privacy Rights Act
|
|
158
|
+
* (CPRA)).
|
|
159
|
+
*
|
|
160
|
+
* This option:
|
|
161
|
+
* - applies only when `analyticsMode` is explicitly set to `'legacy'`;
|
|
162
|
+
* - has no effect with `analyticsMode: 'next'`, which does not honor these signals;
|
|
163
|
+
* - does not override an explicit `enabled: false` or a runtime
|
|
164
|
+
* `disableAnalytics()` call, which always disable analytics.
|
|
165
|
+
*
|
|
166
|
+
* @deprecated Introduced as deprecated on purpose to signal that it is
|
|
167
|
+
* transitional. This option exists only to bridge legacy-analytics deployments
|
|
168
|
+
* where a browser privacy signal is enforced by policy, and it will be removed
|
|
169
|
+
* when legacy analytics is removed (see KIT-2844). Migrate to Event Protocol
|
|
170
|
+
* (`analyticsMode: 'next'`) rather than relying on this option long term.
|
|
171
|
+
*
|
|
172
|
+
* @defaultValue `false`
|
|
173
|
+
*/
|
|
174
|
+
disableBrowserPrivacySignals?: boolean;
|
|
141
175
|
}
|
|
142
176
|
export type AnalyticsRuntimeEnvironment = IRuntimeEnvironment;
|
|
143
177
|
export declare const engineConfigurationDefinitions: SchemaDefinition<EngineConfiguration>;
|
|
@@ -4,7 +4,7 @@ import type { InsightAppState } from '../../state/insight-app-state.js';
|
|
|
4
4
|
import { type CoreEngine, type ExternalEngineOptions } from '../engine.js';
|
|
5
5
|
import type { InsightThunkExtraArguments } from '../insight-thunk-extra-arguments.js';
|
|
6
6
|
import { getSampleInsightEngineConfiguration, type InsightEngineConfiguration, type InsightEngineSearchConfigurationOptions } from './insight-engine-configuration.js';
|
|
7
|
-
export type { InsightEngineConfiguration, InsightEngineSearchConfigurationOptions
|
|
7
|
+
export type { InsightEngineConfiguration, InsightEngineSearchConfigurationOptions };
|
|
8
8
|
export { getSampleInsightEngineConfiguration };
|
|
9
9
|
declare const insightEngineReducers: {
|
|
10
10
|
insightConfiguration: import("@reduxjs/toolkit").Reducer<import("../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState> & {
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import type { InsightAPIClient } from '../api/service/insight/insight-api-client.js';
|
|
2
|
+
import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
|
|
2
3
|
import type { ClientThunkExtraArguments } from './thunk-extra-arguments.js';
|
|
3
4
|
export interface InsightThunkExtraArguments extends ClientThunkExtraArguments<InsightAPIClient> {
|
|
5
|
+
generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient;
|
|
4
6
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import type { GeneratedAnswerAPIClient } from '../api/generated-answer/generated-answer-client.js';
|
|
2
2
|
import type { SearchAPIClient } from '../api/search/search-api-client.js';
|
|
3
|
+
import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
|
|
3
4
|
import type { ClientThunkExtraArguments } from './thunk-extra-arguments.js';
|
|
4
5
|
export interface SearchThunkExtraArguments extends ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient> {
|
|
6
|
+
generatedAnswerAnalyticsClient: GeneratedAnswerAnalyticsClient;
|
|
5
7
|
}
|
|
@@ -3,6 +3,7 @@ import type { AnalyticsClientSendEventHook } from 'coveo.analytics';
|
|
|
3
3
|
import type { Logger } from 'pino';
|
|
4
4
|
import type { GeneratedAnswerAPIClient } from '../api/generated-answer/generated-answer-client.js';
|
|
5
5
|
import { type PreprocessRequest } from '../api/preprocess-request.js';
|
|
6
|
+
import type { GeneratedAnswerAnalyticsClient } from '../features/generated-answer/generated-answer-analytics-client.js';
|
|
6
7
|
import { validatePayloadAndThrow } from '../utils/validate-payload.js';
|
|
7
8
|
import type { EngineConfiguration } from './engine-configuration.js';
|
|
8
9
|
import type { NavigatorContext } from './navigator-context-provider.js';
|
|
@@ -11,11 +12,19 @@ export interface ClientThunkExtraArguments<T, K = GeneratedAnswerAPIClient> exte
|
|
|
11
12
|
streamingClient?: K;
|
|
12
13
|
relay: Relay;
|
|
13
14
|
navigatorContext: NavigatorContext;
|
|
15
|
+
generatedAnswerAnalyticsClient?: GeneratedAnswerAnalyticsClient;
|
|
14
16
|
}
|
|
15
17
|
export interface ThunkExtraArguments {
|
|
16
18
|
preprocessRequest?: PreprocessRequest;
|
|
17
19
|
analyticsClientMiddleware: AnalyticsClientSendEventHook;
|
|
18
20
|
logger: Logger;
|
|
19
21
|
validatePayload: typeof validatePayloadAndThrow;
|
|
22
|
+
/**
|
|
23
|
+
* Legacy-analytics-only, immutable engine policy. When `true`, browser privacy
|
|
24
|
+
* signals (Do Not Track and Global Privacy Control) are not honored. Sourced from
|
|
25
|
+
* the engine configuration at build time and intentionally kept out of Redux
|
|
26
|
+
* analytics state so it cannot be mutated at runtime.
|
|
27
|
+
*/
|
|
28
|
+
disableBrowserPrivacySignals?: boolean;
|
|
20
29
|
}
|
|
21
30
|
export declare function buildThunkExtraArguments(configuration: EngineConfiguration, logger: Logger): ThunkExtraArguments;
|
package/force-app/main/default/staticresources/coveoheadless/definitions/case-assist.index.d.ts
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
export type { Relay } from '@coveo/relay';
|
|
17
17
|
export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
|
|
18
|
-
export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint
|
|
18
|
+
export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint } from './api/platform-client.js';
|
|
19
19
|
export type { Raw } from './api/search/search/raw.js';
|
|
20
20
|
export type { Result } from './api/search/search/result.js';
|
|
21
21
|
export type { DocumentSuggestionResponse } from './api/service/case-assist/get-document-suggestions/get-document-suggestions-response.js';
|
|
@@ -29,7 +29,7 @@ export type { CaseField, CaseFieldOptions, CaseFieldProps, CaseFieldState, Updat
|
|
|
29
29
|
export { buildCaseField } from './controllers/case-field/headless-case-field.js';
|
|
30
30
|
export type { CaseInput, CaseInputOptions, CaseInputProps, CaseInputState, UpdateFetchOptions, } from './controllers/case-input/headless-case-input.js';
|
|
31
31
|
export { buildCaseInput } from './controllers/case-input/headless-case-input.js';
|
|
32
|
-
export type { Controller, Subscribable
|
|
32
|
+
export type { Controller, Subscribable } from './controllers/controller/headless-controller.js';
|
|
33
33
|
export { buildController } from './controllers/controller/headless-controller.js';
|
|
34
34
|
export type { Quickview, QuickviewOptions, QuickviewProps, QuickviewState, } from './controllers/core/quickview/headless-core-quickview.js';
|
|
35
35
|
export type { CaseAssistInteractiveResult, CaseAssistInteractiveResultOptions, CaseAssistInteractiveResultProps, InteractiveResultCore, InteractiveResultCoreOptions, InteractiveResultCoreProps, } from './controllers/document-suggestion-list/case-assist-headless-interactive-result.js';
|
package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts
CHANGED
|
@@ -22,18 +22,18 @@ export type { Relay } from '@coveo/relay';
|
|
|
22
22
|
export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
|
|
23
23
|
export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
|
|
24
24
|
export type { CartItemParam } from './api/commerce/commerce-api-params.js';
|
|
25
|
-
export type { BaseProduct, ChildProduct, Product
|
|
26
|
-
export type { BaseResult, Result, SpotlightContent
|
|
25
|
+
export type { BaseProduct, ChildProduct, Product } from './api/commerce/common/product.js';
|
|
26
|
+
export type { BaseResult, Result, SpotlightContent } from './api/commerce/common/result.js';
|
|
27
27
|
export { ResultType } from './api/commerce/common/result.js';
|
|
28
28
|
export type { Badge, BadgePlacement, BadgesProduct, } from './api/commerce/product-enrichment/product-enrichment-response.js';
|
|
29
|
-
export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint
|
|
30
|
-
export { deserializeRelativeDate, validateRelativeDate
|
|
29
|
+
export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint } from './api/platform-client.js';
|
|
30
|
+
export { deserializeRelativeDate, validateRelativeDate } from './api/search/date/relative-date.js';
|
|
31
31
|
export type { CategoryFacetSearchResult } from './api/search/facet-search/category-facet-search/category-facet-search-response.js';
|
|
32
32
|
export type { SpecificFacetSearchResult as RegularFacetSearchResult } from './api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
|
|
33
33
|
export type { CommerceEngine, CommerceEngineConfiguration, CommerceEngineOptions, } from './app/commerce-engine/commerce-engine.js';
|
|
34
34
|
export { buildCommerceEngine } from './app/commerce-engine/commerce-engine.js';
|
|
35
35
|
export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
|
|
36
|
-
export type { CoreEngine, CoreEngineNext, ExternalEngineOptions
|
|
36
|
+
export type { CoreEngine, CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
|
|
37
37
|
export type { AnalyticsConfiguration, AnalyticsRuntimeEnvironment, EngineConfiguration, } from './app/engine-configuration.js';
|
|
38
38
|
export type { LoggerOptions, LogLevel } from './app/logger.js';
|
|
39
39
|
export type { NavigatorContext } from './app/navigator-context-provider.js';
|
|
@@ -96,7 +96,7 @@ export { buildNotifyTrigger } from './controllers/commerce/triggers/headless-not
|
|
|
96
96
|
export type { QueryTriggerOptions } from './controllers/commerce/triggers/headless-query-trigger.js';
|
|
97
97
|
export { buildQueryTrigger } from './controllers/commerce/triggers/headless-query-trigger.js';
|
|
98
98
|
export { buildRedirectionTrigger } from './controllers/commerce/triggers/headless-redirection-trigger.js';
|
|
99
|
-
export type { Controller, Subscribable
|
|
99
|
+
export type { Controller, Subscribable } from './controllers/controller/headless-controller.js';
|
|
100
100
|
export { buildController } from './controllers/controller/headless-controller.js';
|
|
101
101
|
export type { DateFilterRange } from './controllers/core/facets/range-facet/date-facet/headless-core-date-filter.js';
|
|
102
102
|
export type { InteractiveResultCore } from './controllers/core/interactive-result/headless-core-interactive-result.js';
|
|
@@ -5,7 +5,7 @@ export type { Breadcrumb, BreadcrumbValue, CategoryFacetBreadcrumb, CoreBreadcru
|
|
|
5
5
|
/**
|
|
6
6
|
* The `BreadcrumbManager` headless controller manages a summary of the currently active facet filters.
|
|
7
7
|
*
|
|
8
|
-
* Example: [
|
|
8
|
+
* Example: [breadcrumbs.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/breadcrumbs.tsx)
|
|
9
9
|
*
|
|
10
10
|
* @group Controllers
|
|
11
11
|
* @category BreadcrumbManager
|
|
@@ -3,7 +3,7 @@ import { buildFieldsSortCriterion, buildRelevanceSortCriterion, SortBy, type Sor
|
|
|
3
3
|
import { type Controller } from '../../../controller/headless-controller.js';
|
|
4
4
|
import type { FetchProductsActionCreator } from '../common.js';
|
|
5
5
|
export type { SortByFields, SortByFieldsFields, SortByRelevance, SortCriterion };
|
|
6
|
-
export { buildFieldsSortCriterion, buildRelevanceSortCriterion, SortBy, SortDirection
|
|
6
|
+
export { buildFieldsSortCriterion, buildRelevanceSortCriterion, SortBy, SortDirection };
|
|
7
7
|
export interface SortProps {
|
|
8
8
|
/**
|
|
9
9
|
* The initial state that should be applied to this `Sort` sub-controller.
|
|
@@ -4,7 +4,7 @@ import type { Parameters } from '../../../../features/commerce/parameters/parame
|
|
|
4
4
|
import type { Serializer } from '../../../../features/commerce/parameters/parameters-serializer.js';
|
|
5
5
|
import { type UrlManagerProps as BaseUrlManagerProps, type UrlManager, type UrlManagerInitialState, type UrlManagerState } from '../../../url-manager/headless-url-manager.js';
|
|
6
6
|
import type { ParameterManager, ParameterManagerProps } from '../parameter-manager/headless-core-parameter-manager.js';
|
|
7
|
-
export type { BaseUrlManagerProps, UrlManager, UrlManagerInitialState, UrlManagerState
|
|
7
|
+
export type { BaseUrlManagerProps, UrlManager, UrlManagerInitialState, UrlManagerState };
|
|
8
8
|
export interface UrlManagerProps extends BaseUrlManagerProps {
|
|
9
9
|
/**
|
|
10
10
|
* Whether the controller's state should exclude the default parameters returned by the Commerce API, and only include
|
|
@@ -10,7 +10,7 @@ import type { ProductListingSummaryState } from './summary/headless-product-list
|
|
|
10
10
|
/**
|
|
11
11
|
* The `ProductListing` controller exposes a method for retrieving product listing content in a commerce interface.
|
|
12
12
|
*
|
|
13
|
-
* Example: [product-listing.
|
|
13
|
+
* Example: [product-listing-page.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/commerce-react/src/pages/product-listing-page.tsx)
|
|
14
14
|
*
|
|
15
15
|
* @group Buildable controllers
|
|
16
16
|
* @category ProductListing
|
|
@@ -7,7 +7,7 @@ import type { SummaryState } from '../core/summary/headless-core-summary.js';
|
|
|
7
7
|
/**
|
|
8
8
|
* The `Recommendations` controller exposes a method for retrieving recommendations content in a commerce interface.
|
|
9
9
|
*
|
|
10
|
-
* Example: [
|
|
10
|
+
* Example: [home-page.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/commerce-react/src/pages/home-page.tsx)
|
|
11
11
|
*
|
|
12
12
|
* @group Buildable controllers
|
|
13
13
|
* @category Recommendations
|
|
@@ -7,7 +7,7 @@ import { type SearchSubControllers } from '../core/sub-controller/headless-sub-c
|
|
|
7
7
|
/**
|
|
8
8
|
* The `Search` controller lets you create a commerce search page.
|
|
9
9
|
*
|
|
10
|
-
* Example: [search.
|
|
10
|
+
* Example: [search-page.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/commerce-react/src/pages/search-page.tsx)
|
|
11
11
|
*
|
|
12
12
|
* @group Buildable controllers
|
|
13
13
|
* @category Search
|
|
@@ -18,7 +18,6 @@ export interface ContextInitialState {
|
|
|
18
18
|
* The `Context` controller injects [custom contextual information](https://docs.coveo.com/en/3389/)
|
|
19
19
|
* into the search requests and usage analytics search events sent from a search interface.
|
|
20
20
|
*
|
|
21
|
-
* Example: [context.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/context/context.ts)
|
|
22
21
|
*
|
|
23
22
|
* @group Controllers
|
|
24
23
|
* @category Context
|
|
@@ -27,7 +27,6 @@ export interface DidYouMeanOptions {
|
|
|
27
27
|
/**
|
|
28
28
|
* The `DidYouMean` controller is responsible for handling query corrections.
|
|
29
29
|
*
|
|
30
|
-
* Example: [did-you-mean.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/did-you-mean/did-you-mean.fn.tsx)
|
|
31
30
|
*
|
|
32
31
|
* @group Controllers
|
|
33
32
|
* @category DidYouMean
|
|
@@ -16,7 +16,6 @@ export interface FacetManagerPayload<T> {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `FacetManager` controller helps reorder facets to match the most recent search response.
|
|
18
18
|
*
|
|
19
|
-
* Example: [facet-manager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet-manager/facet-manager.fn.tsx)
|
|
20
19
|
*
|
|
21
20
|
* @group Controllers
|
|
22
21
|
* @category FacetManager
|
|
@@ -12,10 +12,6 @@ export interface CategoryFacetProps {
|
|
|
12
12
|
/**
|
|
13
13
|
* The `CategoryFacet` headless controller offers a high-level interface for designing a facet UI controller that renders values hierarchically.
|
|
14
14
|
*
|
|
15
|
-
* Example:
|
|
16
|
-
* - [category-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/category-facet/category-facet.fn.tsx)
|
|
17
|
-
* - [category-facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/category-facet/category-facet-search.tsx)
|
|
18
|
-
*
|
|
19
15
|
* @group Controllers
|
|
20
16
|
* @category CategoryFacet
|
|
21
17
|
*/
|
|
@@ -16,11 +16,6 @@ interface CoreFacetProps {
|
|
|
16
16
|
* If you have enabled a [Dynamic Navigation Experience (DNE)](https://docs.coveo.com/en/m2na0333/)
|
|
17
17
|
* model, the `Facet` controller automatically reorders facet values according to the user query.
|
|
18
18
|
*
|
|
19
|
-
* Examples:
|
|
20
|
-
* - [facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet.fn.tsx)
|
|
21
|
-
* - [facet-search.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet-search.tsx)
|
|
22
|
-
* - [facet.class.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet/facet.class.tsx)
|
|
23
|
-
*
|
|
24
19
|
* @group Controllers
|
|
25
20
|
* @category Facet
|
|
26
21
|
*/
|
|
@@ -5,7 +5,7 @@ import type { RangeFacetSortCriterion } from '../../../../../features/facets/ran
|
|
|
5
5
|
import type { Controller } from '../../../../controller/headless-controller.js';
|
|
6
6
|
import { buildDateRange, type DateRangeInput, type DateRangeOptions } from './date-range.js';
|
|
7
7
|
import { type DateFacetOptions } from './headless-date-facet-options.js';
|
|
8
|
-
export type { DateFacetOptions, DateRangeInput, DateRangeOptions, DateRangeRequest
|
|
8
|
+
export type { DateFacetOptions, DateRangeInput, DateRangeOptions, DateRangeRequest };
|
|
9
9
|
export { buildDateRange };
|
|
10
10
|
export interface DateFacetProps {
|
|
11
11
|
/**
|
|
@@ -16,10 +16,6 @@ export interface DateFacetProps {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `DateFacet` controller makes it possible to create a facet with date ranges.
|
|
18
18
|
*
|
|
19
|
-
* Examples:
|
|
20
|
-
* - [date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/date-facet/date-facet.fn.tsx)
|
|
21
|
-
* - [relative-date-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/relative-date-facet/relative-date-facet.fn.tsx)
|
|
22
|
-
*
|
|
23
19
|
* @document relative-date-format.md
|
|
24
20
|
*
|
|
25
21
|
* @group Controllers
|
|
@@ -93,7 +93,6 @@ export interface DateFilterState {
|
|
|
93
93
|
/**
|
|
94
94
|
* The `DateFilter` controller makes it possible to create a date filter.
|
|
95
95
|
*
|
|
96
|
-
* Example: [date-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/date-filter/date-filter.fn.tsx)
|
|
97
96
|
*
|
|
98
97
|
* @group Controllers
|
|
99
98
|
* @category DateFilter
|
|
@@ -16,7 +16,6 @@ export interface NumericFacetProps {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `NumericFacet` controller makes it possible to create a facet with numeric ranges.
|
|
18
18
|
*
|
|
19
|
-
* Example: [numeric-facet.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/numeric-facet/numeric-facet.fn.tsx)
|
|
20
19
|
*
|
|
21
20
|
* @group Controllers
|
|
22
21
|
* @category NumericFacet
|
|
@@ -93,7 +93,6 @@ export interface NumericFilterState {
|
|
|
93
93
|
/**
|
|
94
94
|
* The `NumericFilter` controller makes it possible to create a numeric filter.
|
|
95
95
|
*
|
|
96
|
-
* Example: [numeric-filter.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/numeric-filter/numeric-filter.fn.tsx)
|
|
97
96
|
*
|
|
98
97
|
* @group Controllers
|
|
99
98
|
* @category NumericFilter
|
|
@@ -53,7 +53,6 @@ export interface CoreFoldedResultListProps {
|
|
|
53
53
|
/**
|
|
54
54
|
* The `FoldedResultList` headless controller re-organizes results into hierarchical collections (a.k.a. threads).
|
|
55
55
|
*
|
|
56
|
-
* Example: [folded-result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/folded-result-list/folded-result-list.fn.tsx)
|
|
57
56
|
*
|
|
58
57
|
* @group Controllers
|
|
59
58
|
* @category FoldedResultList
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
2
|
-
import type { CustomAction, LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
|
|
3
2
|
import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
|
|
3
|
+
import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
|
|
4
4
|
import type { GeneratedAnswerState } from '../../../features/generated-answer/generated-answer-state.js';
|
|
5
5
|
import type { GeneratedResponseFormat } from '../../../features/generated-answer/generated-response-format.js';
|
|
6
6
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
@@ -101,30 +101,6 @@ export interface GeneratedAnswer extends Controller {
|
|
|
101
101
|
*/
|
|
102
102
|
logCitationHover(citationId: string, citationHoverTimeMs: number, answerId: string): void;
|
|
103
103
|
}
|
|
104
|
-
export interface GeneratedAnswerAnalyticsClient {
|
|
105
|
-
/** @deprecated */
|
|
106
|
-
logLikeGeneratedAnswer(): CustomAction;
|
|
107
|
-
logLikeGeneratedAnswer(answerId?: string): CustomAction;
|
|
108
|
-
/** @deprecated */
|
|
109
|
-
logDislikeGeneratedAnswer(): CustomAction;
|
|
110
|
-
logDislikeGeneratedAnswer(answerId?: string): CustomAction;
|
|
111
|
-
logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
|
|
112
|
-
/** @deprecated */
|
|
113
|
-
logOpenGeneratedAnswerSource(citationId: string): CustomAction;
|
|
114
|
-
logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
|
|
115
|
-
logOpenGeneratedAnswerFollowUpSource?(citationId: string, answerId: string): CustomAction;
|
|
116
|
-
/** @deprecated */
|
|
117
|
-
logHoverCitation(citationId: string, citationHoverTimeMs: number): CustomAction;
|
|
118
|
-
logHoverCitation(citationId: string, citationHoverTimeMs: number, answerId?: string): CustomAction;
|
|
119
|
-
logGeneratedAnswerShowAnswers: () => CustomAction;
|
|
120
|
-
logGeneratedAnswerHideAnswers: () => CustomAction;
|
|
121
|
-
/** @deprecated */
|
|
122
|
-
logCopyGeneratedAnswer(): CustomAction;
|
|
123
|
-
logCopyGeneratedAnswer(answerId?: string): CustomAction;
|
|
124
|
-
logRetryGeneratedAnswer: () => LegacySearchAction;
|
|
125
|
-
logGeneratedAnswerExpand: () => CustomAction;
|
|
126
|
-
logGeneratedAnswerCollapse: () => CustomAction;
|
|
127
|
-
}
|
|
128
104
|
export interface GeneratedAnswerPropsInitialState {
|
|
129
105
|
initialState?: {
|
|
130
106
|
/**
|
|
@@ -6,7 +6,8 @@ import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
|
|
|
6
6
|
import type { ClientThunkExtraArguments } from '../../../app/thunk-extra-arguments.js';
|
|
7
7
|
import type { ConfigurationState } from '../../../features/configuration/configuration-state.js';
|
|
8
8
|
import type { DebugSection, GeneratedAnswerSection, SearchSection } from '../../../state/state-sections.js';
|
|
9
|
-
import { type GeneratedAnswer, type
|
|
9
|
+
import { type GeneratedAnswer, type GeneratedAnswerProps } from './headless-core-generated-answer.js';
|
|
10
|
+
import type { GeneratedAnswerAnalyticsClient } from '../../../features/generated-answer/generated-answer-analytics-client.js';
|
|
10
11
|
interface SearchAPIGeneratedAnswer extends GeneratedAnswer {
|
|
11
12
|
}
|
|
12
13
|
interface SubscribeStateManager {
|
|
@@ -27,8 +27,6 @@ export interface PagerProps {
|
|
|
27
27
|
/**
|
|
28
28
|
* The `Pager` controller allows to navigate through the different result pages.
|
|
29
29
|
*
|
|
30
|
-
* [pager.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/pager/pager.fn.tsx)
|
|
31
|
-
*
|
|
32
30
|
* @group Controllers
|
|
33
31
|
* @category Pager
|
|
34
32
|
*/
|
|
@@ -4,7 +4,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
/**
|
|
5
5
|
* The `QueryError` controller allows to retrieve information about the current error returned by the search API, if any.
|
|
6
6
|
*
|
|
7
|
-
* Example: [query-error.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/query-error/query-error.fn.tsx)
|
|
8
7
|
*
|
|
9
8
|
* @group Controllers
|
|
10
9
|
* @category QueryError
|
|
@@ -32,7 +32,6 @@ export interface RecentQueriesListOptions {
|
|
|
32
32
|
/**
|
|
33
33
|
* The `RecentQueriesList` controller manages the user's recent queries.
|
|
34
34
|
*
|
|
35
|
-
* Example: [recent-queries.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/recent-queries/recent-queries.fn.tsx)
|
|
36
35
|
*
|
|
37
36
|
* @group Controllers
|
|
38
37
|
* @category RecentQueriesList
|
|
@@ -24,8 +24,6 @@ export interface ResultListProps {
|
|
|
24
24
|
/**
|
|
25
25
|
* The `ResultList` headless controller offers a high-level interface for designing a common result list UI controller.
|
|
26
26
|
*
|
|
27
|
-
* Example: [result-list.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/result-list/result-list.fn.tsx)
|
|
28
|
-
*
|
|
29
27
|
* @group Controllers
|
|
30
28
|
* @category ResultList
|
|
31
29
|
*/
|
|
@@ -15,7 +15,6 @@ export interface ResultsPerPageInitialState {
|
|
|
15
15
|
/**
|
|
16
16
|
* The `ResultsPerPage` controller allows the end user to choose how many results to display per page.
|
|
17
17
|
*
|
|
18
|
-
* Example: [results-per-page.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/results-per-page/results-per-page.fn.tsx)
|
|
19
18
|
*
|
|
20
19
|
* @group Controllers
|
|
21
20
|
* @category ResultsPerPage
|
|
@@ -16,8 +16,6 @@ export interface SortInitialState {
|
|
|
16
16
|
/**
|
|
17
17
|
* The `Sort` controller manages how the results are sorted.
|
|
18
18
|
*
|
|
19
|
-
* Example: [sort.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/sort/sort.fn.tsx)
|
|
20
|
-
*
|
|
21
19
|
* @group Controllers
|
|
22
20
|
* @category Sort
|
|
23
21
|
*/
|
|
@@ -3,7 +3,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
3
3
|
/**
|
|
4
4
|
* The `SearchStatus` controller lets you access search status information.
|
|
5
5
|
*
|
|
6
|
-
* Example: [search-status.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/search-status/search-status.fn.tsx)
|
|
7
6
|
*
|
|
8
7
|
* @group Controllers
|
|
9
8
|
* @category SearchStatus
|
|
@@ -38,7 +38,6 @@ export interface TabProps {
|
|
|
38
38
|
/**
|
|
39
39
|
* The `Tab` headless controller offers a high-level interface for designing a common tab UI controller.
|
|
40
40
|
*
|
|
41
|
-
* Example: [tab.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/tab/tab.fn.tsx)
|
|
42
41
|
*
|
|
43
42
|
* @group Controllers
|
|
44
43
|
* @category Tab
|
|
@@ -4,7 +4,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
/**
|
|
5
5
|
* The `NotifyTrigger` controller handles notify triggers. A [Notify trigger](https://docs.coveo.com/en/3413#notify) query pipeline rule lets you define a message to be displayed to the end user when a certain condition is met.
|
|
6
6
|
*
|
|
7
|
-
* Example: [notify-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/notify-trigger.fn.tsx)
|
|
8
7
|
*
|
|
9
8
|
* @group Controllers
|
|
10
9
|
* @category NotifyTrigger
|
|
@@ -2,7 +2,6 @@ import type { Controller } from '../../controller/headless-controller.js';
|
|
|
2
2
|
/**
|
|
3
3
|
* The `QueryTrigger` controller handles [query trigger](https://docs.coveo.com/en/3413#query) query pipeline rules, which let you define a search query to execute when a certain condition is met.
|
|
4
4
|
*
|
|
5
|
-
* Example: [query-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/query-trigger.fn.tsx)
|
|
6
5
|
*
|
|
7
6
|
* @group Controllers
|
|
8
7
|
* @category QueryTrigger
|
|
@@ -2,7 +2,6 @@ import type { Controller } from '../../controller/headless-controller.js';
|
|
|
2
2
|
/**
|
|
3
3
|
* The `RedirectionTrigger` controller handles redirection triggers. A [Redirection trigger](https://docs.coveo.com/en/3413#redirect) query pipeline rule lets you define a URL to redirect the user's browser to when a certain condition is met.
|
|
4
4
|
*
|
|
5
|
-
* Example: [redirection-trigger.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/triggers/redirection-trigger.fn.tsx)
|
|
6
5
|
*
|
|
7
6
|
* @group Controllers
|
|
8
7
|
* @category RedirectionTrigger
|
|
@@ -5,7 +5,6 @@ export type { DictionaryFieldContextPayload };
|
|
|
5
5
|
/**
|
|
6
6
|
* The `DictionaryFieldContext` controller allows specifying which [dictionary field](https://docs.coveo.com/en/2036/) keys to retrieve.
|
|
7
7
|
*
|
|
8
|
-
* Example: [dictionary-field-context.fn.ts](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/dictionary-field-context/dictionary-field-context.fn.ts)
|
|
9
8
|
*
|
|
10
9
|
* @group Controllers
|
|
11
10
|
* @category DictionaryFieldContext
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Result } from '../../api/search/search/result.js';
|
|
2
2
|
import type { CaseAssistEngine } from '../../app/case-assist-engine/case-assist-engine.js';
|
|
3
3
|
import { type InteractiveResultCore, type InteractiveResultCoreOptions, type InteractiveResultCoreProps } from '../core/interactive-result/headless-core-interactive-result.js';
|
|
4
|
-
export type { InteractiveResultCore, InteractiveResultCoreOptions, InteractiveResultCoreProps
|
|
4
|
+
export type { InteractiveResultCore, InteractiveResultCoreOptions, InteractiveResultCoreProps };
|
|
5
5
|
export interface CaseAssistInteractiveResultOptions extends InteractiveResultCoreOptions {
|
|
6
6
|
/**
|
|
7
7
|
* The query result.
|
|
@@ -11,10 +11,6 @@ export type { AutomaticFacetGeneratorOptions };
|
|
|
11
11
|
*
|
|
12
12
|
* To learn more about the automatic facet generator feature, see: [About the Facet Generator](https://docs.coveo.com/en/n9sd0159/).
|
|
13
13
|
*
|
|
14
|
-
* Examples:
|
|
15
|
-
* - [automatic-facet-generator.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/automatic-facet-generator/automatic-facet-generator.fn.tsx)
|
|
16
|
-
* - [automatic-facet-generator.class.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/automatic-facet-generator/automatic-facet-generator.class.tsx)
|
|
17
|
-
*
|
|
18
14
|
* @group Controllers
|
|
19
15
|
* @category AutomaticFacetGenerator
|
|
20
16
|
*/
|
|
@@ -9,6 +9,8 @@ export type { CategoryFacet, CategoryFacetOptions, CategoryFacetProps, CategoryF
|
|
|
9
9
|
* @param props - The configurable `CategoryFacet` properties.
|
|
10
10
|
* @returns A `CategoryFacet` controller instance.
|
|
11
11
|
*
|
|
12
|
+
* Example: [category-facet.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/category-facet.tsx)
|
|
13
|
+
*
|
|
12
14
|
* @group Controllers
|
|
13
15
|
* @category CategoryFacet
|
|
14
16
|
* */
|
|
@@ -16,6 +16,8 @@ export interface FacetProps {
|
|
|
16
16
|
* @param props - The configurable `Facet` properties.
|
|
17
17
|
* @returns A `Facet` controller instance.
|
|
18
18
|
*
|
|
19
|
+
* Example: [facet.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/facet.tsx)
|
|
20
|
+
*
|
|
19
21
|
* @group Controllers
|
|
20
22
|
* @category Facet
|
|
21
23
|
* */
|
|
@@ -54,7 +54,6 @@ export interface CategoryFieldSuggestionsState {
|
|
|
54
54
|
*
|
|
55
55
|
* This controller is a wrapper around the basic category facet controller search functionality, and thus exposes similar options and properties.
|
|
56
56
|
*
|
|
57
|
-
* Example: [category-suggestions.fn.tsx](https://github.com/coveo/ui-kit/blob/main/samples/headless/search-react/src/components/field-suggestions/category-field/category-suggestions.fn.tsx)
|
|
58
57
|
*
|
|
59
58
|
* @group Controllers
|
|
60
59
|
* @category CategoryFieldSuggestions
|