@coveo/quantic 3.36.7 → 3.36.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +14 -14
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts +1 -1
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/result.d.ts +12 -0
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/product-enrichment/product-enrichment-request.d.ts +2 -2
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/plan/plan-request.d.ts +2 -2
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/agents/answer-agent/head-answer-strategy.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-slice.d.ts +0 -5
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +3 -3
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/search-engine.d.ts +1 -1
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts +35 -36
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.d.ts +1 -1
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/headless-core-commerce-facet.d.ts +1 -1
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sort/headless-core-commerce-sort.d.ts +2 -2
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/url-manager/headless-core-url-manager.d.ts +1 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts +1 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/did-you-mean/headless-did-you-mean.d.ts +1 -1
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search-box/headless-search-box.d.ts +1 -1
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/context/headless-context.d.ts +1 -1
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts +1 -1
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-interactive-citation.d.ts +5 -1
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-box/headless-core-search-box.d.ts +1 -1
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/did-you-mean/headless-did-you-mean.d.ts +1 -1
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facet-manager/headless-facet-manager.d.ts +1 -1
  33. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/category-facet/headless-category-facet.d.ts +1 -1
  34. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/facet/headless-facet.d.ts +1 -1
  35. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/date-facet/headless-date-facet.d.ts +1 -1
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/date-facet/headless-date-filter.d.ts +1 -1
  37. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.d.ts +1 -1
  38. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/numeric-facet/headless-numeric-filter.d.ts +1 -1
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/folded-result-list/headless-folded-result-list.d.ts +1 -1
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-generated-answer.d.ts +1 -1
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-interactive-citation.d.ts +1 -1
  42. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/breadcrumb-manager/headless-insight-breadcrumb-manager.d.ts +1 -1
  43. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/did-you-mean/headless-insight-did-you-mean.d.ts +1 -1
  44. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facet-conditions-manager/headless-facet-conditions-manager.d.ts +1 -1
  45. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facet-manager/headless-insight-facet-manager.d.ts +1 -1
  46. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/category-facet/headless-insight-category-facet.d.ts +1 -1
  47. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/facet/headless-insight-facet-options.d.ts +1 -1
  48. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/facet/headless-insight-facet.d.ts +1 -1
  49. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/date-facet/headless-insight-date-facet.d.ts +1 -1
  50. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/date-facet/headless-insight-date-filter.d.ts +1 -1
  51. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-facet.d.ts +1 -1
  52. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-filter.d.ts +1 -1
  53. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/folded-result-list/headless-insight-folded-result-list.d.ts +1 -1
  54. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/generated-answer/headless-insight-generated-answer.d.ts +1 -1
  55. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/generated-answer/headless-insight-interactive-citation.d.ts +1 -1
  56. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/pager/headless-insight-pager.d.ts +1 -1
  57. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/recent-queries-list/headless-insight-recent-queries-list.d.ts +1 -1
  58. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/result-list/headless-insight-interactive-result.d.ts +1 -1
  59. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/result-list/headless-insight-result-list.d.ts +1 -1
  60. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/results-per-page/headless-insight-results-per-page.d.ts +1 -1
  61. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/search-box/headless-insight-search-box.d.ts +1 -1
  62. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/search-parameter-manager/headless-insight-search-parameter-manager.d.ts +1 -1
  63. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/sort/headless-insight-sort.d.ts +1 -1
  64. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/tab/headless-insight-tab.d.ts +1 -1
  65. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/pager/headless-pager.d.ts +1 -1
  66. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts +1 -1
  67. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts +1 -1
  68. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/result-list/headless-recommendation-interactive-result.d.ts +1 -1
  69. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts +1 -1
  70. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-result-list.d.ts +1 -1
  71. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/results-per-page/headless-results-per-page.d.ts +1 -1
  72. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/search-box/headless-search-box.d.ts +1 -1
  73. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/search-parameter-manager/headless-search-parameter-manager.d.ts +1 -1
  74. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/search-status/headless-search-status.d.ts +1 -1
  75. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet/headless-smart-snippet.d.ts +1 -1
  76. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/sort/headless-sort.d.ts +1 -1
  77. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts +1 -1
  78. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts +1 -1
  79. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/tab/headless-tab.d.ts +1 -1
  80. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/generic-analytics-actions-loader.d.ts +1 -1
  81. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/insight-analytics-actions-loader.d.ts +1 -1
  82. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-analytics-actions-loader.d.ts +1 -1
  83. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/date-facet/date-facet-actions-loader.d.ts +1 -1
  84. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/numeric-facet-actions-loader.d.ts +1 -1
  85. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-actions-loader.d.ts +1 -1
  86. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-enrichment/product-enrichment-actions-loader.d.ts +1 -1
  87. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions-loader.d.ts +1 -1
  88. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions-loader.d.ts +1 -1
  89. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/sort/sort.d.ts +1 -1
  90. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/triggers/triggers-actions-loader.d.ts +1 -1
  91. package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-actions-loader.d.ts +1 -1
  92. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facet-options/facet-options-actions-loader.d.ts +1 -1
  93. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions-loader.d.ts +1 -1
  94. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions-loader.d.ts +1 -1
  95. package/force-app/main/default/staticresources/coveoheadless/definitions/features/folding/insight-folding-actions.d.ts +1 -1
  96. package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-actions.d.ts +10 -18
  97. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +11 -25
  98. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +13 -2
  99. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts +1 -1
  100. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +7 -0
  101. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/sse-generated-answer-errors.d.ts +22 -1
  102. package/force-app/main/default/staticresources/coveoheadless/definitions/features/instant-results/instant-results-actions-loader.d.ts +1 -1
  103. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +1 -1
  104. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +1 -1
  105. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-actions.d.ts +0 -1
  106. package/force-app/main/default/staticresources/coveoheadless/definitions/features/standalone-search-box-set/standalone-search-box-set-actions-loader.d.ts +1 -1
  107. package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts +25 -25
  108. package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +5 -5
  109. package/force-app/main/default/staticresources/coveoheadless/definitions/recommendation.index.d.ts +1 -1
  110. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts +1 -1
  111. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/generator/headless-commerce-facet-generator.ssr.d.ts +1 -1
  112. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +1 -1
  113. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts +1 -1
  114. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +1 -1
  115. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/product-enrichment/headless-product-enrichment.ssr.d.ts +1 -1
  116. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/product-list/headless-product-list.ssr.d.ts +15 -3
  117. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts +1 -1
  118. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/search-box/headless-search-box.ssr.d.ts +1 -1
  119. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -1
  120. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/summary/headless-core-summary.ssr.d.ts +1 -1
  121. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/controller-definitions.d.ts +1 -1
  122. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/engine.d.ts +1 -1
  123. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +2 -0
  124. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts +1 -0
  125. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts +1 -1
  126. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.d.ts +1 -1
  127. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +1 -1
  128. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts +1 -1
  129. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +1 -1
  130. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-enrichment/headless-product-enrichment.ssr.d.ts +1 -1
  131. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts +15 -3
  132. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts +1 -1
  133. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/search-box/headless-search-box.ssr.d.ts +1 -1
  134. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +1 -1
  135. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.d.ts +1 -1
  136. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts +3 -2
  137. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +1 -1
  138. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +1 -1
  139. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-inference.d.ts +1 -1
  140. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +1 -1
  141. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/controller-definition.d.ts +1 -1
  142. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-controller.d.ts +2 -1
  143. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-product-listing-controller.d.ts +2 -0
  144. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-controller.d.ts +2 -0
  145. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts +1 -1
  146. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/query-expression/query-expression.d.ts +1 -1
  147. package/force-app/main/default/staticresources/coveoheadless/headless.js +19 -19
  148. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +17 -17
  149. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +13 -13
  150. package/force-app/main/default/staticresources/dompurify/purify.min.js +2 -2
  151. package/package.json +17 -18
  152. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/answer-generation-api-state.d.ts +0 -29
  153. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/answer-generation-api.d.ts +0 -4
  154. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/answer-endpoint.d.ts +0 -30
  155. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/url-builders/endpoint-url-builder.d.ts +0 -5
  156. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.d.ts +0 -24
  157. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/url-builders/endpoint-url-builder.d.ts +0 -5
  158. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/answer-draft-reducer/answer-draft-reducer.d.ts +0 -26
  159. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/answer-streaming-runner.d.ts +0 -26
  160. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/server-state-event-handler/server-state-event-handler.d.ts +0 -21
  161. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/strategies/streaming-strategy-creators.d.ts +0 -4
  162. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/types.d.ts +0 -41
  163. package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answer-request.d.ts +0 -4
  164. package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answer-strategy.d.ts +0 -3
  165. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/head-answer-strategy.d.ts +0 -3
@@ -1,8 +1,6 @@
1
1
  import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
2
- import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
3
2
  import { type GenerationStepName } from '../generated-answer/generated-answer-state.js';
4
3
  import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
5
- import { type StateNeededForFollowUpAnswerParams } from './follow-up-answer-request.js';
6
4
  export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
7
5
  export declare const setFollowUpAnswersConversationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setFollowUpAnswersConversationId", never, never>;
8
6
  export declare const createFollowUpAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
@@ -85,29 +83,23 @@ export declare const submitFollowUpFeedback: import("@reduxjs/toolkit").ActionCr
85
83
  export declare const resetFollowUpAnswers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"followUpAnswers/resetFollowUpAnswers">;
86
84
  export declare const followUpStepStarted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
87
85
  answerId: string;
88
- name: GenerationStepName;
86
+ name: string;
89
87
  startedAt: number;
90
- }], {
88
+ }], Omit<{
91
89
  answerId: string;
92
- name: GenerationStepName;
90
+ name: string;
93
91
  startedAt: number;
92
+ }, "name"> & {
93
+ name: GenerationStepName;
94
94
  }, "followUpAnswers/stepStarted", never, never>;
95
95
  export declare const followUpStepFinished: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
96
96
  answerId: string;
97
- name: GenerationStepName;
97
+ name: string;
98
98
  finishedAt: number;
99
- }], {
99
+ }], Omit<{
100
100
  answerId: string;
101
- name: GenerationStepName;
101
+ name: string;
102
102
  finishedAt: number;
103
+ }, "name"> & {
104
+ name: GenerationStepName;
103
105
  }, "followUpAnswers/stepFinished", never, never>;
104
- export declare const generateFollowUpAnswer: import("@reduxjs/toolkit").AsyncThunk<void, string, {
105
- state: StateNeededForFollowUpAnswerParams;
106
- extra: SearchThunkExtraArguments;
107
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
108
- rejectValue?: unknown;
109
- serializedErrorType?: unknown;
110
- pendingMeta?: unknown;
111
- fulfilledMeta?: unknown;
112
- rejectedMeta?: unknown;
113
- }>;
@@ -2,7 +2,7 @@ import { StringValue } from '@coveo/bueno';
2
2
  import type { GeneratedAnswerCitationsPayload, GeneratedAnswerMessagePayload } from '../../api/generated-answer/generated-answer-event-payload.js';
3
3
  import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
4
4
  import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
5
- import type { AnswerApiQueryParams, StateNeededForHeadAnswerParams } from '../../features/generated-answer/generated-answer-request.js';
5
+ import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
6
6
  import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
7
7
  import { type GenerationStepName } from './generated-answer-state.js';
8
8
  import { type GeneratedResponseFormat } from './generated-response-format.js';
@@ -49,18 +49,22 @@ export declare const setIsAnswerGenerated: import("@reduxjs/toolkit").ActionCrea
49
49
  export declare const setCannotAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setCannotAnswer", never, never>;
50
50
  export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: Partial<AnswerApiQueryParams>], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
51
51
  export declare const startStep: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
52
- name: GenerationStepName;
52
+ name: string;
53
53
  startedAt: number;
54
- }], {
55
- name: GenerationStepName;
54
+ }], Omit<{
55
+ name: string;
56
56
  startedAt: number;
57
+ }, "name"> & {
58
+ name: GenerationStepName;
57
59
  }, "generatedAnswer/startStep", never, never>;
58
60
  export declare const finishStep: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
59
- name: GenerationStepName;
61
+ name: string;
60
62
  finishedAt: number;
61
- }], {
62
- name: GenerationStepName;
63
+ }], Omit<{
64
+ name: string;
63
65
  finishedAt: number;
66
+ }, "name"> & {
67
+ name: GenerationStepName;
64
68
  }, "generatedAnswer/finishStep", never, never>;
65
69
  interface StreamAnswerArgs {
66
70
  setAbortControllerRef: (ref: AbortController) => void;
@@ -98,22 +102,4 @@ export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void,
98
102
  fulfilledMeta?: unknown;
99
103
  rejectedMeta?: unknown;
100
104
  }>;
101
- /**
102
- * Thunk to generate the head answer as part of the generated answer with follow-ups feature.
103
- *
104
- * This action initiates the generation of the main answer when using the Answer Generation API
105
- * with an agent configuration. It requires an **agent ID** to be present in the engine configuration.
106
- *
107
- * @internal
108
- */
109
- export declare const generateHeadAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
110
- state: StateNeededForHeadAnswerParams;
111
- extra: SearchThunkExtraArguments;
112
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
113
- rejectValue?: unknown;
114
- serializedErrorType?: unknown;
115
- pendingMeta?: unknown;
116
- fulfilledMeta?: unknown;
117
- rejectedMeta?: unknown;
118
- }>;
119
105
  export {};
@@ -1,18 +1,29 @@
1
1
  import type { GeneratedAnswerStreamRequest } from '../../api/generated-answer/generated-answer-request.js';
2
- import type { AnswerParams } from '../../api/knowledge/answer-generation/endpoints/answer/answer-endpoint.js';
3
2
  import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
4
3
  import type { BaseParam } from '../../api/platform-service-params.js';
5
4
  import type { SearchRequest } from '../../api/search/search/search-request.js';
6
- import type { AuthenticationParam, AutomaticFacetsParams } from '../../api/search/search-api-params.js';
5
+ import type { AnalyticsParam, AuthenticationParam, AutomaticFacetsParams, PipelineRuleParameters } from '../../api/search/search-api-params.js';
7
6
  import type { CaseContextParam } from '../../api/service/insight/query/query-request.js';
8
7
  import type { NavigatorContext } from '../../app/navigator-context-provider.js';
9
8
  import type { SearchAppState } from '../../state/search-app-state.js';
10
9
  import type { ConfigurationSection, GeneratedAnswerSection, SearchSection, TabSection } from '../../state/state-sections.js';
10
+ import type { AnyFacetRequest } from '../facets/generic/interfaces/generic-facet-request.js';
11
11
  type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection;
12
12
  export interface AnswerApiQueryParams extends Omit<SearchRequest, keyof (BaseParam & AuthenticationParam & AutomaticFacetsParams)>, CaseContextParam {
13
13
  }
14
14
  export declare const buildStreamingRequest: (state: StateNeededByGeneratedAnswerStream) => Promise<GeneratedAnswerStreamRequest>;
15
15
  export declare const constructAnswerAPIQueryParams: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => AnswerApiQueryParams;
16
16
  export type StateNeededForHeadAnswerParams = ConfigurationSection & Partial<SearchAppState> & GeneratedAnswerSection & Partial<TabSection>;
17
+ /**
18
+ * Parameters for answer generation requests.
19
+ */
20
+ type AnswerParams = {
21
+ q: string;
22
+ facets?: AnyFacetRequest[];
23
+ searchHub?: string;
24
+ pipeline?: string;
25
+ pipelineRuleParameters: PipelineRuleParameters;
26
+ locale: string;
27
+ } & AnalyticsParam;
17
28
  export declare const constructGenerateHeadAnswerParams: (state: StateNeededForHeadAnswerParams, navigatorContext: NavigatorContext) => AnswerParams;
18
29
  export {};
@@ -3,7 +3,7 @@ import type { GeneratedAnswerCitation } from '../../controllers/generated-answer
3
3
  import type { SearchAppState } from '../../state/search-app-state.js';
4
4
  import type { GeneratedAnswerSection } from '../../state/state-sections.js';
5
5
  export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
6
- export declare const isGeneratedAnswerFeatureEnabledWithAnswerGenerationAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
6
+ export declare const isGeneratedAnswerFeatureEnabledWithAgentAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
7
7
  export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
8
8
  export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
9
9
  clearCache: () => void;
@@ -4,6 +4,7 @@ import type { GeneratedContentFormat, GeneratedResponseFormat } from './generate
4
4
  type GenerationStepStatus = 'active' | 'completed';
5
5
  export type GenerationStepName = (typeof GENERATION_STEP_NAMES)[number];
6
6
  export declare const GENERATION_STEP_NAMES: readonly ["searching", "thinking", "answering"];
7
+ export declare function normalizeGenerationStepName(name: string): GenerationStepName;
7
8
  export interface GenerationStep {
8
9
  name: GenerationStepName;
9
10
  status: GenerationStepStatus;
@@ -46,6 +47,12 @@ export interface GeneratedAnswerBase {
46
47
  message?: string;
47
48
  code?: number;
48
49
  isRetryable?: boolean;
50
+ isMaxDurationExceededError?(): boolean;
51
+ isFollowupNotSupportedError?(): boolean;
52
+ isConversationNotFoundError?(): boolean;
53
+ isSseModelNotAvailableError?(): boolean;
54
+ isSseInternalError?(): boolean;
55
+ isSseTurnLimitReachedError?(): boolean;
49
56
  };
50
57
  /**
51
58
  * Whether an answer cannot be generated after a query is executed.
@@ -6,9 +6,30 @@ export declare enum GeneratedAnswerSseErrorCode {
6
6
  SseFollowUpNotSupported = 1001,
7
7
  ConversationNotFound = 1002,
8
8
  SseModelsNotAvailable = 1003,
9
- SseInternalError = 1004
9
+ SseInternalError = 1004,
10
+ SseTurnLimitReached = 1005
11
+ }
12
+ interface GeneratedAnswerErrorWithSseHelpers {
13
+ message?: string;
14
+ code?: number;
15
+ isRetryable?: boolean;
16
+ isMaxDurationExceededError(): boolean;
17
+ isFollowupNotSupportedError(): boolean;
18
+ isConversationNotFoundError(): boolean;
19
+ isSseModelNotAvailableError(): boolean;
20
+ isSseInternalError(): boolean;
21
+ isSseTurnLimitReachedError(): boolean;
10
22
  }
11
23
  /**
12
24
  * Maps backend error codes to frontend error codes for generated answer SSE errors.
13
25
  */
14
26
  export declare function mapRunErrorCode(code?: string): GeneratedAnswerSseErrorCode;
27
+ /**
28
+ * Decorates a generated answer error with helper predicates for SSE error codes.
29
+ */
30
+ export declare function withGeneratedAnswerSseErrorHelpers<T extends {
31
+ message?: string;
32
+ code?: number;
33
+ isRetryable?: boolean;
34
+ }>(error?: T): (T & GeneratedAnswerErrorWithSseHelpers) | undefined;
35
+ export {};
@@ -1,7 +1,7 @@
1
1
  import type { PayloadAction } from '@reduxjs/toolkit';
2
2
  import type { SearchEngine } from '../../app/search-engine/search-engine.js';
3
3
  import { type ClearExpiredInstantResultsActionCreatorPayload, type FetchInstantResultsActionCreatorPayload, type RegisterInstantResultActionCreatorPayload, type UpdateInstantResultQueryActionCreatorPayload } from './instant-results-actions.js';
4
- export type { UpdateInstantResultQueryActionCreatorPayload, RegisterInstantResultActionCreatorPayload, ClearExpiredInstantResultsActionCreatorPayload, FetchInstantResultsActionCreatorPayload, };
4
+ export type { ClearExpiredInstantResultsActionCreatorPayload, FetchInstantResultsActionCreatorPayload, RegisterInstantResultActionCreatorPayload, UpdateInstantResultQueryActionCreatorPayload, };
5
5
  /**
6
6
  * The instant results action creators.
7
7
  *
@@ -17,7 +17,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
17
17
  facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
18
18
  numberOfResults?: number;
19
19
  firstResult?: number;
20
- facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
20
+ facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
21
21
  cq?: string;
22
22
  queryCorrection?: {
23
23
  enabled?: boolean;
@@ -18,7 +18,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
18
18
  facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
19
19
  numberOfResults?: number;
20
20
  firstResult?: number;
21
- facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
21
+ facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
22
22
  cq?: string;
23
23
  queryCorrection?: {
24
24
  enabled?: boolean;
@@ -66,7 +66,6 @@ export interface SearchParameters {
66
66
  sf?: Record<string, string[]>;
67
67
  /**
68
68
  * The active tab id.
69
- * @deprecated Restoring the tab with the restoreSearchParameters action can cause components to be visible/hidden on the wrong tab. The `restoreTab` action is also deprecated and will be removed in V4. Use alternative tab management methods instead.
70
69
  */
71
70
  tab?: string;
72
71
  /**
@@ -2,7 +2,7 @@ import type { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
2
2
  import type { AsyncThunkSearchOptions } from '../../api/search/search-api-client.js';
3
3
  import type { SearchEngine } from '../../app/search-engine/search-engine.js';
4
4
  import { type FetchRedirectUrlActionCreatorPayload, type RegisterStandaloneSearchBoxActionCreatorPayload, type ResetStandaloneSearchBoxActionCreatorPayload, type StateNeededForRedirect, type UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload, type UpdateAnalyticsToSearchFromLinkActionCreatorPayload } from './standalone-search-box-set-actions.js';
5
- export type { RegisterStandaloneSearchBoxActionCreatorPayload, ResetStandaloneSearchBoxActionCreatorPayload, FetchRedirectUrlActionCreatorPayload, UpdateAnalyticsToSearchFromLinkActionCreatorPayload, UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload, };
5
+ export type { FetchRedirectUrlActionCreatorPayload, RegisterStandaloneSearchBoxActionCreatorPayload, ResetStandaloneSearchBoxActionCreatorPayload, UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload, UpdateAnalyticsToSearchFromLinkActionCreatorPayload, };
6
6
  /**
7
7
  * The standalone search box set action creators.
8
8
  *
@@ -126,6 +126,12 @@ export { buildUrlManager } from './controllers/url-manager/headless-url-manager.
126
126
  export type { SearchAppState, SearchParametersState, } from './state/search-app-state.js';
127
127
  export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, getSearchApiBaseUrl, } from './api/platform-client.js';
128
128
  export { API_DATE_FORMAT } from './api/search/date/date-format.js';
129
+ export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
130
+ export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
131
+ export type { FieldDescription } from './api/search/fields/fields-response.js';
132
+ export type { Raw } from './api/search/search/raw.js';
133
+ export type { Result } from './api/search/search/result.js';
134
+ export type { PhrasesToHighlight, TermsToHighlight, } from './api/search/search/stemming.js';
129
135
  export * from './features/actions-history/ipx-actions-history-actions-loader.js';
130
136
  export * from './features/advanced-search-queries/advanced-search-queries-actions-loader.js';
131
137
  export * from './features/analytics/click-analytics-actions-loader.js';
@@ -142,13 +148,26 @@ export * from './features/excerpt-length/excerpt-length-actions-loader.js';
142
148
  export * from './features/facet-options/facet-options-actions-loader.js';
143
149
  export * from './features/facets/automatic-facet-set/automatic-facet-set-actions-loader.js';
144
150
  export * from './features/facets/category-facet-set/category-facet-set-actions-loader.js';
151
+ export type { CategoryFacetSortCriterion, CategoryFacetValueRequest, } from './features/facets/category-facet-set/interfaces/request.js';
152
+ export type { CategoryFacetValue, CategoryFacetValueCommon, } from './features/facets/category-facet-set/interfaces/response.js';
153
+ export type { FacetResultsMustMatch } from './features/facets/facet-api/request.js';
145
154
  export * from './features/facets/facet-set/facet-set-actions-loader.js';
146
155
  export { baseFacetResponseSelector, facetRequestSelector, facetResponseSelectedValuesSelector, facetResponseSelector, } from './features/facets/facet-set/facet-set-selectors.js';
156
+ export type { FacetSortCriterion, FacetValueRequest, } from './features/facets/facet-set/interfaces/request.js';
157
+ export type { AnyFacetValueRequest } from './features/facets/generic/interfaces/generic-facet-request.js';
147
158
  export * from './features/facets/range-facets/date-facet-set/date-facet-actions-loader.js';
159
+ export type { DateRangeRequest } from './features/facets/range-facets/date-facet-set/interfaces/request.js';
160
+ export type { DateFacetValue } from './features/facets/range-facets/date-facet-set/interfaces/response.js';
161
+ export type { RangeFacetRangeAlgorithm, RangeFacetSortCriterion, } from './features/facets/range-facets/generic/interfaces/request.js';
162
+ export type { NumericRangeRequest } from './features/facets/range-facets/numeric-facet-set/interfaces/request.js';
163
+ export type { NumericFacetValue } from './features/facets/range-facets/numeric-facet-set/interfaces/response.js';
148
164
  export * from './features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.js';
149
165
  export * from './features/fields/fields-actions-loader.js';
166
+ export { DefaultFieldsToInclude, EcommerceDefaultFieldsToInclude, MinimumFieldsToInclude, } from './features/fields/fields-state.js';
150
167
  export * from './features/folding/folding-actions-loader.js';
151
168
  export * from './features/generated-answer/generated-answer-actions-loader.js';
169
+ export type { GeneratedAnswerFeedback, GeneratedAnswerFeedbackOption, } from './features/generated-answer/generated-answer-analytics-actions.js';
170
+ export type { GeneratedContentFormat } from './features/generated-answer/generated-response-format.js';
152
171
  export * from './features/history/history-actions-loader.js';
153
172
  export * from './features/instant-results/instant-results-actions-loader.js';
154
173
  export * from './features/pagination/pagination-actions-loader.js';
@@ -162,42 +181,23 @@ export * from './features/recent-queries/recent-queries-actions-loader.js';
162
181
  export * from './features/recent-results/recent-results-actions-loader.js';
163
182
  export * from './features/result-preview/result-preview-actions-loader.js';
164
183
  export { ResultTemplatesHelpers } from './features/result-templates/result-templates-helpers.js';
184
+ export type { ResultTemplate, ResultTemplateCondition, ResultTemplatesManager, } from './features/result-templates/result-templates-manager.js';
165
185
  export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
166
186
  export * from './features/search/search-actions-loader.js';
167
187
  export * from './features/search-hub/search-hub-actions-loader.js';
168
188
  export * from './features/search-parameters/search-parameter-actions-loader.js';
169
- export * from './features/sort-criteria/sort-criteria-actions-loader.js';
170
- export * from './features/standalone-search-box-set/standalone-search-box-set-actions-loader.js';
171
- export * from './features/static-filter-set/static-filter-set-actions-loader.js';
172
- export * from './features/tab-set/tab-set-actions-loader.js';
173
- export { HighlightUtils };
174
- export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
175
- export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
176
- export type { FieldDescription } from './api/search/fields/fields-response.js';
177
- export type { Raw } from './api/search/search/raw.js';
178
- export type { Result } from './api/search/search/result.js';
179
- export type { PhrasesToHighlight, TermsToHighlight, } from './api/search/search/stemming.js';
180
- export type { CategoryFacetSortCriterion, CategoryFacetValueRequest, } from './features/facets/category-facet-set/interfaces/request.js';
181
- export type { CategoryFacetValue, CategoryFacetValueCommon, } from './features/facets/category-facet-set/interfaces/response.js';
182
- export type { FacetResultsMustMatch } from './features/facets/facet-api/request.js';
183
- export type { FacetSortCriterion, FacetValueRequest, } from './features/facets/facet-set/interfaces/request.js';
184
- export type { AnyFacetValueRequest } from './features/facets/generic/interfaces/generic-facet-request.js';
185
- export type { DateRangeRequest } from './features/facets/range-facets/date-facet-set/interfaces/request.js';
186
- export type { DateFacetValue } from './features/facets/range-facets/date-facet-set/interfaces/response.js';
187
- export type { RangeFacetRangeAlgorithm, RangeFacetSortCriterion, } from './features/facets/range-facets/generic/interfaces/request.js';
188
- export type { NumericRangeRequest } from './features/facets/range-facets/numeric-facet-set/interfaces/request.js';
189
- export type { NumericFacetValue } from './features/facets/range-facets/numeric-facet-set/interfaces/response.js';
190
- export { DefaultFieldsToInclude, EcommerceDefaultFieldsToInclude, MinimumFieldsToInclude, } from './features/fields/fields-state.js';
191
- export type { GeneratedAnswerFeedback, GeneratedAnswerFeedbackOption, } from './features/generated-answer/generated-answer-analytics-actions.js';
192
- export type { GeneratedContentFormat } from './features/generated-answer/generated-response-format.js';
193
- export type { ResultTemplate, ResultTemplateCondition, ResultTemplatesManager, } from './features/result-templates/result-templates-manager.js';
194
189
  export { buildSearchParameterSerializer } from './features/search-parameters/search-parameter-serializer.js';
195
190
  export type { SortByDate, SortByField, SortByNoSort, SortByQRE, SortByRelevancy, SortCriterion, } from './features/sort-criteria/criteria.js';
196
191
  export { buildCriterionExpression, buildDateSortCriterion, buildFieldSortCriterion, buildNoSortCriterion, buildQueryRankingExpressionSortCriterion, buildRelevanceSortCriterion, SortBy, SortOrder, } from './features/sort-criteria/criteria.js';
197
192
  export { parseCriterionExpression } from './features/sort-criteria/criteria-parser.js';
193
+ export * from './features/sort-criteria/sort-criteria-actions-loader.js';
194
+ export * from './features/standalone-search-box-set/standalone-search-box-set-actions-loader.js';
195
+ export * from './features/static-filter-set/static-filter-set-actions-loader.js';
196
+ export * from './features/tab-set/tab-set-actions-loader.js';
198
197
  export type { Template, TemplatesManager, } from './features/templates/templates-manager.js';
199
198
  export type { FunctionExecutionTrigger } from './features/triggers/triggers-state.js';
200
199
  export type { HighlightKeyword } from './utils/highlight.js';
201
200
  export * from './utils/query-expression/query-expression.js';
202
201
  export type { PlatformEnvironment } from './utils/url-utils.js';
203
202
  export { VERSION } from './utils/version.js';
203
+ export { HighlightUtils };
@@ -16,6 +16,9 @@
16
16
  import * as HighlightUtils from './utils/highlight.js';
17
17
  export type { Relay } from '@coveo/relay';
18
18
  export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
19
+ export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
20
+ export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
21
+ export { deserializeRelativeDate } from './api/search/date/relative-date.js';
19
22
  export type { Raw } from './api/search/search/raw.js';
20
23
  export type { Result } from './api/search/search/result.js';
21
24
  export type { InsightAPIErrorStatusResponse } from './api/service/insight/insight-api-client.js';
@@ -121,11 +124,8 @@ export * from './features/recent-results/recent-results-actions-loader.js';
121
124
  export { ResultTemplatesHelpers } from './features/result-templates/result-templates-helpers.js';
122
125
  export type { ResultTemplate, ResultTemplateCondition, ResultTemplatesManager, } from './features/result-templates/result-templates-manager.js';
123
126
  export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
124
- export type { HighlightKeyword } from './utils/highlight.js';
125
- export { HighlightUtils };
126
- export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
127
- export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
128
- export { deserializeRelativeDate } from './api/search/date/relative-date.js';
129
127
  export { buildCriterionExpression, buildDateSortCriterion, buildRelevanceSortCriterion, SortOrder, } from './features/sort-criteria/criteria.js';
128
+ export type { HighlightKeyword } from './utils/highlight.js';
130
129
  export type { PlatformEnvironment } from './utils/url-utils.js';
131
130
  export { VERSION } from './utils/version.js';
131
+ export { HighlightUtils };
@@ -14,7 +14,6 @@
14
14
  * @module Recommendation
15
15
  */
16
16
  import * as HighlightUtils from './utils/highlight.js';
17
- export { HighlightUtils };
18
17
  export type { Relay } from '@coveo/relay';
19
18
  export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
20
19
  export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
@@ -54,3 +53,4 @@ export { buildResultTemplatesManager } from './features/result-templates/result-
54
53
  export * from './features/search-hub/search-hub-actions-loader.js';
55
54
  export type { HighlightKeyword } from './utils/highlight.js';
56
55
  export type { PlatformEnvironment } from './utils/url-utils.js';
56
+ export { HighlightUtils };
@@ -3,7 +3,7 @@ import type { CategoryFilterSuggestions, CategoryFilterSuggestionsState } from '
3
3
  import type { FilterSuggestions, FilterSuggestionsState } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
4
4
  import { type FilterSuggestionsGenerator, type GeneratedFilterSuggestionsControllers } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
5
5
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
6
- export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, FieldSuggestionsFacet, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FilterSuggestions, FilterSuggestionsState, };
6
+ export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, };
7
7
  export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
8
8
  }
9
9
  /**
@@ -11,7 +11,7 @@ import type { RegularFacet, RegularFacetState } from '../../../../controllers/co
11
11
  import type { LocationFacetValue, RegularFacetValue } from '../../../../features/commerce/facets/facet-set/interfaces/response.js';
12
12
  import { SolutionType } from '../../types/controller-constants.js';
13
13
  import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
14
- export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, CategoryFacetValue, CategoryFacetSearchResult, CoreCommerceFacet, DateFacet, DateFacetValue, DateFacetState, NumericFacet, NumericFacetValue, NumericFacetState, RegularFacet, RegularFacetState, RegularFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, };
14
+ export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, };
15
15
  export type FacetGeneratorState = MappedFacetStates;
16
16
  export type MappedFacetStates = Array<MappedFacetState[FacetType]>;
17
17
  export type { FacetType };
@@ -1,6 +1,6 @@
1
1
  import { type InstantProducts, type InstantProductsOptions, type InstantProductsProps, type InstantProductsState } from '../../../../controllers/commerce/instant-products/headless-instant-products.js';
2
2
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
- export type { InstantProductsOptions, InstantProductsState, InstantProducts, InstantProductsProps, };
3
+ export type { InstantProducts, InstantProductsOptions, InstantProductsProps, InstantProductsState, };
4
4
  export interface InstantProductsDefinition extends NonRecommendationControllerDefinitionWithoutProps<InstantProducts> {
5
5
  }
6
6
  /**
@@ -1,6 +1,6 @@
1
1
  import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
2
2
  import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
- export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
3
+ export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState, };
4
4
  /**
5
5
  * Defines a `Pagination` controller instance.
6
6
  * @group Definers
@@ -3,7 +3,7 @@ import type { Parameters } from '../../../../features/commerce/parameters/parame
3
3
  import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
4
4
  import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
5
5
  import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
6
- export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
6
+ export type { CommerceSearchParameters, ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, };
7
7
  /**
8
8
  * @deprecated In the future, the parameterManager controller will be included by default in the engine definition. You will no longer need to define it manually
9
9
  * Defines a `ParameterManager` controller instance.
@@ -1,6 +1,6 @@
1
1
  import { type ProductEnrichment, type ProductEnrichmentProps, type ProductEnrichmentState } from '../../../../controllers/commerce/product-enrichment/headless-product-enrichment.js';
2
2
  import type { StandaloneControllerWithProps } from '../../types/controller-definitions.js';
3
- export type { ProductEnrichmentState, ProductEnrichment, ProductEnrichmentProps };
3
+ export type { ProductEnrichment, ProductEnrichmentProps, ProductEnrichmentState };
4
4
  export interface ProductEnrichmentDefinition extends StandaloneControllerWithProps<ProductEnrichment, ProductEnrichmentProps> {
5
5
  }
6
6
  /**
@@ -1,12 +1,24 @@
1
1
  import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
2
2
  import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
3
3
  import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
4
- export type { Search, ProductListing, ProductListingState as ProductListState };
5
- export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
4
+ export type { ProductListing, ProductListingState as ProductListState, Search };
5
+ export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'interactiveSpotlightContent' | 'promoteChildToParent'>;
6
+ /**
7
+ * Options for configuring the `ProductList` controller.
8
+ */
9
+ interface ProductListOptions {
10
+ /**
11
+ * When set to true, fills the `results` field rather than the `products` field
12
+ * in the response. It may also include Spotlight Content in the results.
13
+ * @default false
14
+ */
15
+ enableResults?: boolean;
16
+ }
6
17
  /**
7
18
  * Defines a `ProductList` controller instance.
8
19
  * @group Definers
9
20
  *
21
+ * @param options - The configurable `ProductList` controller options.
10
22
  * @returns The `ProductList` controller definition.
11
23
  */
12
- export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;
24
+ export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions & ProductListOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;
@@ -1,6 +1,6 @@
1
1
  import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
2
2
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
- export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
3
+ export type { RecentQueriesList, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, };
4
4
  export interface RecentQueriesListDefinition extends NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList> {
5
5
  }
6
6
  /**
@@ -1,6 +1,6 @@
1
1
  import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
2
2
  import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
- export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
3
+ export type { CoreSearchBox, SearchBox, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, };
4
4
  export interface SearchBoxDefinition extends SearchOnlyControllerDefinitionWithoutProps<SearchBox> {
5
5
  }
6
6
  /**
@@ -1,7 +1,7 @@
1
1
  import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../../../controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
2
2
  import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
3
3
  import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
4
- export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
4
+ export type { StandaloneSearchBox, StandaloneSearchBoxProps, StandaloneSearchBoxState, };
5
5
  export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
6
6
  }
7
7
  /**
@@ -3,7 +3,7 @@ import type { ProductListingSummaryState } from '../../../../controllers/commerc
3
3
  import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
4
4
  import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
5
5
  import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
6
- export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
6
+ export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryState, };
7
7
  /**
8
8
  * Defines a `Summary` controller instance.
9
9
  * @group Definers
@@ -9,7 +9,7 @@ import type { SSRCommerceEngine } from '../factories/build-factory.js';
9
9
  import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
10
10
  import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, StandaloneController, UniversalController } from './controller-scopes.js';
11
11
  import type { Kind } from './kind.js';
12
- export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
12
+ export type { EngineDefinitionBuildResult, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, };
13
13
  export type RecommendationControllerSettings = {
14
14
  /**
15
15
  * @deprecated In the next major version, recommendation controllers will be enabled by simply including their names in the `recommendations` array when calling `fetchStaticState`, rather than using this `enabled` property.
@@ -13,7 +13,7 @@ import type { InferControllerPropsMapFromDefinitions, InferControllerStaticState
13
13
  import type { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
14
14
  import type { FromBuildResult } from './from-build-result.js';
15
15
  import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
16
- export type { FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, Build, BuildOptions, };
16
+ export type { Build, BuildOptions, FetchStaticState, FetchStaticStateOptions, FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, };
17
17
  export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
18
18
  searchActions: TSearchAction[];
19
19
  controllers: TControllers;
@@ -158,6 +158,8 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
158
158
  export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
159
159
  export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
160
160
  export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
161
+ export type { Result, SpotlightContent, } from './api/commerce/common/result.js';
162
+ export { ResultType } from './api/commerce/common/result.js';
161
163
  export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
162
164
  export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
163
165
  export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
@@ -154,6 +154,7 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
154
154
  export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
155
155
  export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
156
156
  export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
157
+ export type { Result, SpotlightContent, } from './api/commerce/common/result.js';
157
158
  export { ResultType } from './api/commerce/common/result.js';
158
159
  export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
159
160
  export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
@@ -3,7 +3,7 @@ import type { CategoryFilterSuggestions, CategoryFilterSuggestionsState } from '
3
3
  import type { FilterSuggestions, FilterSuggestionsState } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
4
4
  import { type FilterSuggestionsGenerator, type GeneratedFilterSuggestionsControllers } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
5
5
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
6
- export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, FieldSuggestionsFacet, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FilterSuggestions, FilterSuggestionsState, };
6
+ export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, };
7
7
  export type FilterSuggestionsGeneratorDefinition = NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator>;
8
8
  /**
9
9
  * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
@@ -11,7 +11,7 @@ import type { RegularFacet, RegularFacetState } from '../../../../controllers/co
11
11
  import type { LocationFacetValue, RegularFacetValue } from '../../../../features/commerce/facets/facet-set/interfaces/response.js';
12
12
  import { SolutionType } from '../../types/controller-constants.js';
13
13
  import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
14
- export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, CategoryFacetValue, CategoryFacetSearchResult, CoreCommerceFacet, DateFacet, DateFacetValue, DateFacetState, NumericFacet, NumericFacetValue, NumericFacetState, RegularFacet, RegularFacetState, RegularFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, };
14
+ export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, };
15
15
  export type FacetGeneratorState = MappedFacetStates;
16
16
  export type MappedFacetStates = Array<MappedFacetState[FacetType]>;
17
17
  export type { FacetType };