@coveo/quantic 3.33.3 → 3.33.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.
Files changed (147) hide show
  1. package/docs/out/quantic-docs.json +13 -13
  2. package/force-app/main/default/lwc/quanticCategoryFacet/quanticCategoryFacet.js +1 -1
  3. package/force-app/main/default/lwc/quanticCitation/__tests__/quanticCitation.test.js +142 -3
  4. package/force-app/main/default/lwc/quanticCitation/quanticCitation.html +10 -4
  5. package/force-app/main/default/lwc/quanticCitation/quanticCitation.js +72 -31
  6. package/force-app/main/default/lwc/quanticFacet/quanticFacet.js +1 -1
  7. package/force-app/main/default/lwc/quanticHeading/quanticHeading.js +1 -1
  8. package/force-app/main/default/lwc/quanticResultsPerPage/quanticResultsPerPage.js +1 -1
  9. package/force-app/main/default/lwc/quanticSummary/quanticSummary.js +1 -1
  10. package/force-app/main/default/lwc/quanticTimeframe/quanticTimeframe.js +2 -2
  11. package/force-app/main/default/lwc/quanticUtils/facetDependenciesUtils.js +2 -2
  12. package/force-app/main/default/lwc/quanticUtils/quanticUtils.js +4 -4
  13. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/product.d.ts +2 -2
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/date/date-format.d.ts +1 -1
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/plan/plan-response.d.ts +1 -1
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search/stemming.d.ts +2 -2
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/app/case-assist-engine/case-assist-engine-configuration.d.ts +1 -1
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-engine/commerce-engine-configuration.d.ts +1 -1
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/app/engine-configuration.d.ts +7 -7
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-engine/insight-engine-configuration.d.ts +1 -1
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/app/recommendation-engine/recommendation-engine-configuration.d.ts +1 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/search-engine-configuration.d.ts +1 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.d.ts +1 -1
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts +2 -2
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts +1 -1
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts +1 -1
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/instant-products/headless-instant-products.d.ts +1 -1
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts +2 -2
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts +1 -1
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +3 -3
  33. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/headless-search.d.ts +2 -2
  34. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
  35. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-context.d.ts +1 -1
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts +1 -1
  37. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facet-manager/headless-core-facet-manager.d.ts +2 -2
  38. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts +2 -2
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +4 -4
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.d.ts +2 -2
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts +1 -1
  42. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
  43. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts +1 -1
  44. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +1 -1
  45. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/pager/headless-core-pager.d.ts +1 -1
  46. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/query-error/headless-core-query-error.d.ts +1 -1
  47. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/recent-queries-list/headless-core-recent-queries-list.d.ts +3 -3
  48. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/result-list/headless-core-result-list.d.ts +1 -1
  49. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts +1 -1
  50. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-box/headless-core-search-box-options.d.ts +3 -3
  51. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts +1 -1
  52. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts +1 -1
  53. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/status/headless-core-status.d.ts +1 -1
  54. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/tab/headless-core-tab.d.ts +1 -1
  55. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +1 -1
  56. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-query-trigger.d.ts +1 -1
  57. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts +1 -1
  58. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts +1 -1
  59. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.d.ts +3 -3
  60. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts +1 -1
  61. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts +1 -1
  62. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/history-manager/headless-history-manager.d.ts +1 -1
  63. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results.d.ts +1 -1
  64. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.d.ts +1 -1
  65. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts +1 -1
  66. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts +1 -1
  67. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/headless-recommendation.d.ts +1 -1
  68. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts +1 -1
  69. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-interactive-result.d.ts +1 -1
  70. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts +1 -1
  71. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts +1 -1
  72. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts +1 -1
  73. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/static-filter-value.d.ts +2 -2
  74. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.d.ts +2 -2
  75. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/url-manager/headless-url-manager.d.ts +5 -5
  76. package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-queries-state.d.ts +6 -6
  77. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-actions.d.ts +2 -2
  78. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts +3 -3
  79. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-analytics-actions-loader.d.ts +1 -1
  80. package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts +1 -1
  81. package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-state.d.ts +1 -1
  82. package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-actions.d.ts +1 -1
  83. package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-input/case-input-actions.d.ts +1 -1
  84. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-actions.d.ts +1 -1
  85. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-state.d.ts +1 -1
  86. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/core-facet/core-facet-actions.d.ts +1 -1
  87. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/location-facet/location-facet-actions.d.ts +1 -1
  88. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/manual-numeric-facet-selectors.d.ts +1 -21
  89. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/numeric-facet-actions.d.ts +3 -3
  90. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-selectors.d.ts +6 -126
  91. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-selectors.d.ts +6 -160
  92. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query/query-actions.d.ts +1 -1
  93. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +1 -1
  94. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-selectors.d.ts +2 -42
  95. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions.d.ts +1 -1
  96. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +7 -181
  97. package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-actions.d.ts +13 -13
  98. package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-selectors.d.ts +4 -48
  99. package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-state.d.ts +5 -5
  100. package/force-app/main/default/staticresources/coveoheadless/definitions/features/context/context-actions-loader.d.ts +1 -1
  101. package/force-app/main/default/staticresources/coveoheadless/definitions/features/context/context-selector.d.ts +2 -24
  102. package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/ranking-info-parser.d.ts +1 -1
  103. package/force-app/main/default/staticresources/coveoheadless/definitions/features/dictionary-field-context/dictionary-field-context-actions-loader.d.ts +1 -1
  104. package/force-app/main/default/staticresources/coveoheadless/definitions/features/did-you-mean/did-you-mean-actions-loader.d.ts +1 -1
  105. package/force-app/main/default/staticresources/coveoheadless/definitions/features/did-you-mean/did-you-mean-selectors.d.ts +1 -21
  106. package/force-app/main/default/staticresources/coveoheadless/definitions/features/excerpt-length/excerpt-length-selectors.d.ts +2 -24
  107. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facet-options/facet-options-actions-loader.d.ts +2 -2
  108. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions-loader.d.ts +1 -1
  109. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions.d.ts +5 -5
  110. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions-loader.d.ts +1 -1
  111. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions.d.ts +6 -6
  112. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions-loader.d.ts +1 -1
  113. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions.d.ts +3 -3
  114. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.d.ts +1 -1
  115. package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions.d.ts +3 -3
  116. package/force-app/main/default/staticresources/coveoheadless/definitions/features/fields/fields-actions-loader.d.ts +1 -1
  117. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +3 -2
  118. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-mocks.d.ts +11 -0
  119. package/force-app/main/default/staticresources/coveoheadless/definitions/features/instant-items/instant-items-state.d.ts +1 -1
  120. package/force-app/main/default/staticresources/coveoheadless/definitions/features/pipeline/select-pipeline.d.ts +2 -24
  121. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-actions.d.ts +2 -2
  122. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-selectors.d.ts +4 -48
  123. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-state.d.ts +2 -2
  124. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-actions.d.ts +6 -6
  125. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-state.d.ts +2 -2
  126. package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-state.d.ts +2 -2
  127. package/force-app/main/default/staticresources/coveoheadless/definitions/features/recommendation/recommendation-state.d.ts +1 -1
  128. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +1 -1
  129. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-hub/search-hub-selectors.d.ts +2 -24
  130. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-actions.d.ts +1 -1
  131. package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort-criteria/criteria-parser.d.ts +2 -2
  132. package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort-criteria/sort-criteria-selectors.d.ts +2 -24
  133. package/force-app/main/default/staticresources/coveoheadless/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts +1 -1
  134. package/force-app/main/default/staticresources/coveoheadless/definitions/features/static-filter-set/static-filter-set-state.d.ts +2 -2
  135. package/force-app/main/default/staticresources/coveoheadless/definitions/features/tab-set/tab-set-actions-loader.d.ts +1 -1
  136. package/force-app/main/default/staticresources/coveoheadless/definitions/features/tab-set/tab-set-actions.d.ts +1 -1
  137. package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +0 -1
  138. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts +0 -1
  139. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts +0 -1
  140. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/static-filter/headless-static-filter.ssr.d.ts +0 -1
  141. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts +0 -1
  142. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts +0 -1
  143. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/controllers/static-filter/headless-static-filter.ssr.d.ts +0 -1
  144. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
  145. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
  146. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
  147. package/package.json +2 -2
@@ -3,7 +3,7 @@ import type { PlatformEnvironment } from '../../utils/url-utils.js';
3
3
  import type { CoveoFramework } from '../../utils/version.js';
4
4
  export interface CoreConfigurationState<Analytics extends CoreAnalyticsState = CoreAnalyticsState> {
5
5
  /**
6
- * The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.
6
+ * The access token to use to authenticate requests against the Coveo endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo organization.
7
7
  */
8
8
  accessToken: string;
9
9
  /**
@@ -13,13 +13,13 @@ export interface CoreConfigurationState<Analytics extends CoreAnalyticsState = C
13
13
  /**
14
14
  * The environment in which the Coveo cloud organization is hosted.
15
15
  *
16
- * The `dev` and `stg` environments are only available internally for Coveo employees (e.g., Professional Services).
16
+ * The `dev` and `stg` environments are only available internally for Coveo employees (for example, Professional Services).
17
17
  *
18
18
  * Defaults to `prod`.
19
19
  */
20
20
  environment: PlatformEnvironment;
21
21
  /**
22
- * The unique identifier of the target Coveo Cloud organization (e.g., `mycoveocloudorganizationg8tp8wu3`)
22
+ * The unique identifier of the target Coveo organization (for example, `mycoveocloudorganizationg8tp8wu3`)
23
23
  */
24
24
  organizationId: string;
25
25
  }
@@ -39,7 +39,7 @@ interface SearchState {
39
39
  *
40
40
  * By default, will append `/rest/search/v2` to the automatically resolved
41
41
  * platform [organization endpoint](https://docs.coveo.com/en/mcc80216)
42
- * (i.e., `https;://<ORG_ID>.org<hipaa|dev|stg|>.coveo.com`)
42
+ * (that is, `https;://<ORG_ID>.org<hipaa|dev|stg|>.coveo.com`)
43
43
  *
44
44
  * If necessary, you can override this value by specifying a `proxyBaseUrl` in the `search` object of your engine
45
45
  * configuration, or when manually dispatching the `updateSearchConfiguration` action.
@@ -128,7 +128,7 @@ export interface CoreAnalyticsState {
128
128
  * By default, will append `/rest/organizations/${organizationId}/events/v1` (or `/rest/v15/analytics` if
129
129
  * `analyticsMode`is set to `legacy`) to the automatically resolved analytics
130
130
  * [organization endpoint](https://docs.coveo.com/en/mcc80216)
131
- * (i.e., `https;://<ORG_ID>.analytics.org<hipaa|dev|stg|>.coveo.com`)
131
+ * (that is, `https;://<ORG_ID>.analytics.org<hipaa|dev|stg|>.coveo.com`)
132
132
  *
133
133
  * If necessary, you can override this value by specifying a `proxyBaseUrl` in the `analytics` object of your engine
134
134
  * configuration, or when manually dispatching the `updateAnalyticsConfiguration` action.
@@ -20,7 +20,7 @@ export interface ContextActionCreators {
20
20
  /**
21
21
  * Removes a context key-value pair.
22
22
  *
23
- * @param key - The key to remove from the context (e.g., "age").
23
+ * @param key - The key to remove from the context (for example, "age").
24
24
  * @returns A dispatchable action.
25
25
  */
26
26
  removeContext(key: string): PayloadAction<string>;
@@ -1,26 +1,4 @@
1
1
  import type { ContextState } from './context-state.js';
2
- export declare const selectContext: ((state: {
2
+ export declare const selectContext: (state: {
3
3
  context?: ContextState;
4
- }) => ContextState | undefined) & {
5
- clearCache: () => void;
6
- resultsCount: () => number;
7
- resetResultsCount: () => void;
8
- } & {
9
- resultFunc: (resultFuncArgs_0: ContextState | undefined) => ContextState | undefined;
10
- memoizedResultFunc: ((resultFuncArgs_0: ContextState | undefined) => ContextState | undefined) & {
11
- clearCache: () => void;
12
- resultsCount: () => number;
13
- resetResultsCount: () => void;
14
- };
15
- lastResult: () => ContextState | undefined;
16
- dependencies: [(state: {
17
- context?: ContextState;
18
- }) => ContextState | undefined];
19
- recomputations: () => number;
20
- resetRecomputations: () => void;
21
- dependencyRecomputations: () => number;
22
- resetDependencyRecomputations: () => void;
23
- } & {
24
- argsMemoize: typeof import("reselect").weakMapMemoize;
25
- memoize: typeof import("reselect").weakMapMemoize;
26
- };
4
+ }) => ContextState | undefined;
@@ -84,7 +84,7 @@ interface TermWeights {
84
84
  */
85
85
  Concept: number;
86
86
  /**
87
- * The weight allocated when query terms are formatted in the document (e.g., heading level, bold, large, etc.).
87
+ * The weight allocated when query terms are formatted in the document (for example, heading level, bold, large, etc.).
88
88
  */
89
89
  Formatted: number;
90
90
  /**
@@ -20,7 +20,7 @@ export interface DictionaryFieldContextActionCreators {
20
20
  /**
21
21
  * Removes a dictionary field context field-key pair.
22
22
  *
23
- * @param field - The field to remove from the context (e.g., "price").
23
+ * @param field - The field to remove from the context (for example, "price").
24
24
  * @returns A dispatchable action.
25
25
  */
26
26
  removeContext(field: string): PayloadAction<string>;
@@ -11,7 +11,7 @@ export interface DidYouMeanActionCreators {
11
11
  /**
12
12
  * Applies a did-you-mean correction.
13
13
  *
14
- * @param correction - The target correction (e.g., "corrected string").
14
+ * @param correction - The target correction (for example, "corrected string").
15
15
  * @returns A dispatchable action.
16
16
  */
17
17
  applyDidYouMeanCorrection(correction: string): PayloadAction<string>;
@@ -1,23 +1,3 @@
1
1
  import type { DidYouMeanState as CommerceDidYouMeanState } from '../commerce/did-you-mean/did-you-mean-state.js';
2
2
  import type { DidYouMeanState } from './did-you-mean-state.js';
3
- export declare const hasQueryCorrectionSelector: ((state: DidYouMeanState | CommerceDidYouMeanState) => boolean) & {
4
- clearCache: () => void;
5
- resultsCount: () => number;
6
- resetResultsCount: () => void;
7
- } & {
8
- resultFunc: (resultFuncArgs_0: boolean) => boolean;
9
- memoizedResultFunc: ((resultFuncArgs_0: boolean) => boolean) & {
10
- clearCache: () => void;
11
- resultsCount: () => number;
12
- resetResultsCount: () => void;
13
- };
14
- lastResult: () => boolean;
15
- dependencies: [(state: CommerceDidYouMeanState | DidYouMeanState) => boolean];
16
- recomputations: () => number;
17
- resetRecomputations: () => void;
18
- dependencyRecomputations: () => number;
19
- resetDependencyRecomputations: () => void;
20
- } & {
21
- argsMemoize: typeof import("reselect").weakMapMemoize;
22
- memoize: typeof import("reselect").weakMapMemoize;
23
- };
3
+ export declare const hasQueryCorrectionSelector: (state: CommerceDidYouMeanState | DidYouMeanState) => boolean;
@@ -1,26 +1,4 @@
1
1
  import type { ExcerptLengthState } from './excerpt-length-state.js';
2
- export declare const selectExcerptLength: ((state: {
2
+ export declare const selectExcerptLength: (state: {
3
3
  excerptLength?: ExcerptLengthState;
4
- }) => number | undefined) & {
5
- clearCache: () => void;
6
- resultsCount: () => number;
7
- resetResultsCount: () => void;
8
- } & {
9
- resultFunc: (resultFuncArgs_0: number | undefined) => number | undefined;
10
- memoizedResultFunc: ((resultFuncArgs_0: number | undefined) => number | undefined) & {
11
- clearCache: () => void;
12
- resultsCount: () => number;
13
- resetResultsCount: () => void;
14
- };
15
- lastResult: () => number | undefined;
16
- dependencies: [(state: {
17
- excerptLength?: ExcerptLengthState;
18
- }) => number | undefined];
19
- recomputations: () => number;
20
- resetRecomputations: () => void;
21
- dependencyRecomputations: () => number;
22
- resetDependencyRecomputations: () => void;
23
- } & {
24
- argsMemoize: typeof import("reselect").weakMapMemoize;
25
- memoize: typeof import("reselect").weakMapMemoize;
26
- };
4
+ }) => number | undefined;
@@ -19,14 +19,14 @@ export interface FacetOptionsActionCreators {
19
19
  /**
20
20
  * Enables a facet. I.e., undoes the effects of `disable`.
21
21
  *
22
- * @param facetId - The unique identifier of the facet (e.g., "abcd").
22
+ * @param facetId - The unique identifier of the facet (for example, "abcd").
23
23
  * @returns A dispatchable action.
24
24
  */
25
25
  enableFacet(facetId: string): PayloadAction<string>;
26
26
  /**
27
27
  * Disables a facet. I.e., prevents it from filtering results.
28
28
  *
29
- * @param facetId - The unique identifier of the facet (e.g., "1").
29
+ * @param facetId - The unique identifier of the facet (for example, "1").
30
30
  * @returns A dispatchable action.
31
31
  */
32
32
  disableFacet(facetId: string): PayloadAction<string>;
@@ -13,7 +13,7 @@ export interface CategoryFacetSetActionCreators {
13
13
  /**
14
14
  * Deselects all values of a category facet.
15
15
  *
16
- * @param facetId - The unique identifier of the facet (e.g., "1").
16
+ * @param facetId - The unique identifier of the facet (for example, "1").
17
17
  * @returns A dispatchable action.
18
18
  */
19
19
  deselectAllCategoryFacetValues(facetId: string): PayloadAction<string>;
@@ -78,7 +78,7 @@ export declare const defaultNumberOfValuesIncrement = 5;
78
78
  export declare const registerCategoryFacet: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterCategoryFacetActionCreatorPayload], RegisterCategoryFacetActionCreatorPayload, "categoryFacet/register", never, never>;
79
79
  export interface ToggleSelectCategoryFacetValueActionCreatorPayload {
80
80
  /**
81
- * The unique identifier of the facet (e.g., `"1"`).
81
+ * The unique identifier of the facet (for example, `"1"`).
82
82
  */
83
83
  facetId: string;
84
84
  /**
@@ -94,18 +94,18 @@ export declare const toggleSelectCategoryFacetValue: import("@reduxjs/toolkit").
94
94
  export declare const deselectAllCategoryFacetValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "categoryFacet/deselectAll", never, never>;
95
95
  export interface UpdateCategoryFacetNumberOfValuesActionCreatorPayload {
96
96
  /**
97
- * The unique identifier of the facet (e.g., `"1"`).
97
+ * The unique identifier of the facet (for example, `"1"`).
98
98
  */
99
99
  facetId: string;
100
100
  /**
101
- * The new number of facet values (e.g., `10`).
101
+ * The new number of facet values (for example, `10`).
102
102
  */
103
103
  numberOfValues: number;
104
104
  }
105
105
  export declare const updateCategoryFacetNumberOfValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateCategoryFacetNumberOfValuesActionCreatorPayload], UpdateCategoryFacetNumberOfValuesActionCreatorPayload, "categoryFacet/updateNumberOfValues", never, never>;
106
106
  export interface UpdateCategoryFacetSortCriterionActionCreatorPayload {
107
107
  /**
108
- * The unique identifier of the facet (e.g., `"1"`).
108
+ * The unique identifier of the facet (for example, `"1"`).
109
109
  */
110
110
  facetId: string;
111
111
  /**
@@ -116,7 +116,7 @@ export interface UpdateCategoryFacetSortCriterionActionCreatorPayload {
116
116
  export declare const updateCategoryFacetSortCriterion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateCategoryFacetSortCriterionActionCreatorPayload], UpdateCategoryFacetSortCriterionActionCreatorPayload, "categoryFacet/updateSortCriterion", never, never>;
117
117
  export interface UpdateCategoryFacetBasePathActionCreatorPayload {
118
118
  /**
119
- * The unique identifier of the facet (e.g., `"1"`).
119
+ * The unique identifier of the facet (for example, `"1"`).
120
120
  */
121
121
  facetId: string;
122
122
  /**
@@ -13,7 +13,7 @@ export interface FacetSetActionCreators {
13
13
  /**
14
14
  * Deselects all values of a facet.
15
15
  *
16
- * @param facetId - The unique identifier of the facet (e.g., `"1"`).
16
+ * @param facetId - The unique identifier of the facet (for example, `"1"`).
17
17
  * @returns A dispatchable action.
18
18
  */
19
19
  deselectAllFacetValues(facetId: string): PayloadAction<string>;
@@ -95,7 +95,7 @@ export interface RegisterFacetActionCreatorPayload {
95
95
  export declare const registerFacet: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterFacetActionCreatorPayload], RegisterFacetActionCreatorPayload, "facet/register", never, never>;
96
96
  export interface ToggleSelectFacetValueActionCreatorPayload {
97
97
  /**
98
- * The unique identifier of the facet (e.g., `"1"`).
98
+ * The unique identifier of the facet (for example, `"1"`).
99
99
  */
100
100
  facetId: string;
101
101
  /**
@@ -108,7 +108,7 @@ export declare const toggleExcludeFacetValue: import("@reduxjs/toolkit").ActionC
108
108
  export declare const deselectAllFacetValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "facet/deselectAll", never, never>;
109
109
  export interface UpdateFacetSortCriterionActionCreatorPayload {
110
110
  /**
111
- * The unique identifier of the facet (e.g., `"1"`).
111
+ * The unique identifier of the facet (for example, `"1"`).
112
112
  */
113
113
  facetId: string;
114
114
  /**
@@ -119,18 +119,18 @@ export interface UpdateFacetSortCriterionActionCreatorPayload {
119
119
  export declare const updateFacetSortCriterion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFacetSortCriterionActionCreatorPayload], UpdateFacetSortCriterionActionCreatorPayload, "facet/updateSortCriterion", never, never>;
120
120
  export interface UpdateFacetNumberOfValuesActionCreatorPayload {
121
121
  /**
122
- * The unique identifier of the facet (e.g., `"1"`).
122
+ * The unique identifier of the facet (for example, `"1"`).
123
123
  */
124
124
  facetId: string;
125
125
  /**
126
- * The new number of facet values (e.g., `10`).
126
+ * The new number of facet values (for example, `10`).
127
127
  */
128
128
  numberOfValues: number;
129
129
  }
130
130
  export declare const updateFacetNumberOfValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFacetNumberOfValuesActionCreatorPayload], UpdateFacetNumberOfValuesActionCreatorPayload, "facet/updateNumberOfValues", never, never>;
131
131
  export interface UpdateFacetIsFieldExpandedActionCreatorPayload {
132
132
  /**
133
- * The unique identifier of the facet (e.g., `"1"`).
133
+ * The unique identifier of the facet (for example, `"1"`).
134
134
  */
135
135
  facetId: string;
136
136
  /**
@@ -141,7 +141,7 @@ export interface UpdateFacetIsFieldExpandedActionCreatorPayload {
141
141
  export declare const updateFacetIsFieldExpanded: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateFacetIsFieldExpandedActionCreatorPayload], UpdateFacetIsFieldExpandedActionCreatorPayload, "facet/updateIsFieldExpanded", never, never>;
142
142
  export interface UpdateFreezeCurrentValuesActionCreatorPayload {
143
143
  /**
144
- * The unique identifier of the facet (e.g., `"1"`).
144
+ * The unique identifier of the facet (for example, `"1"`).
145
145
  */
146
146
  facetId: string;
147
147
  /**
@@ -12,7 +12,7 @@ export interface DateFacetSetActionCreators {
12
12
  /**
13
13
  * Deselects all values of a date facet.
14
14
  *
15
- * @param facetId - The unique identifier of the facet (e.g., `"1"`).
15
+ * @param facetId - The unique identifier of the facet (for example, `"1"`).
16
16
  * @returns A dispatchable action.
17
17
  */
18
18
  deselectAllDateFacetValues(facetId: string): PayloadAction<string>;
@@ -83,7 +83,7 @@ export declare function validateManualDateRanges(options: Pick<RegisterDateFacet
83
83
  export declare const registerDateFacet: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterDateFacetActionCreatorPayload], RegisterDateFacetActionCreatorPayload, "dateFacet/register", import("@reduxjs/toolkit").SerializedError | null, never>;
84
84
  export interface ToggleSelectDateFacetValueActionCreatorPayload {
85
85
  /**
86
- * The unique identifier of the facet (e.g., `"1"`).
86
+ * The unique identifier of the facet (for example, `"1"`).
87
87
  */
88
88
  facetId: string;
89
89
  /**
@@ -95,7 +95,7 @@ export declare const toggleSelectDateFacetValue: import("@reduxjs/toolkit").Acti
95
95
  export declare const toggleExcludeDateFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectDateFacetValueActionCreatorPayload], ToggleSelectDateFacetValueActionCreatorPayload, "dateFacet/toggleExcludeValue", never, never>;
96
96
  export interface UpdateDateFacetValuesActionCreatorPayload {
97
97
  /**
98
- * The unique identifier of the facet (e.g., `"1"`).
98
+ * The unique identifier of the facet (for example, `"1"`).
99
99
  */
100
100
  facetId: string;
101
101
  /**
@@ -106,7 +106,7 @@ export interface UpdateDateFacetValuesActionCreatorPayload {
106
106
  export declare const updateDateFacetValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateDateFacetValuesActionCreatorPayload], UpdateDateFacetValuesActionCreatorPayload, "dateFacet/updateFacetValues", import("@reduxjs/toolkit").SerializedError | null, never>;
107
107
  export interface UpdateDateFacetSortCriterionActionCreatorPayload {
108
108
  /**
109
- * The unique identifier of the facet (e.g., `"1"`).
109
+ * The unique identifier of the facet (for example, `"1"`).
110
110
  */
111
111
  facetId: string;
112
112
  /**
@@ -12,7 +12,7 @@ export interface NumericFacetSetActionCreators {
12
12
  /**
13
13
  * Deselects all values of a numeric facet.
14
14
  *
15
- * @param facetId - The unique identifier of the facet (e.g., "1").
15
+ * @param facetId - The unique identifier of the facet (for example, "1").
16
16
  * @returns A dispatchable action.
17
17
  */
18
18
  deselectAllNumericFacetValues(facetId: string): PayloadAction<string>;
@@ -83,7 +83,7 @@ export declare function validateManualNumericRanges(options: Pick<RegisterNumeri
83
83
  export declare const registerNumericFacet: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterNumericFacetActionCreatorPayload], RegisterNumericFacetActionCreatorPayload, "numericFacet/register", import("@reduxjs/toolkit").SerializedError | null, never>;
84
84
  export interface ToggleSelectNumericFacetValueActionCreatorPayload {
85
85
  /**
86
- * The unique identifier of the facet (e.g., `"1"`).
86
+ * The unique identifier of the facet (for example, `"1"`).
87
87
  */
88
88
  facetId: string;
89
89
  /**
@@ -95,7 +95,7 @@ export declare const toggleSelectNumericFacetValue: import("@reduxjs/toolkit").A
95
95
  export declare const toggleExcludeNumericFacetValue: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ToggleSelectNumericFacetValueActionCreatorPayload], ToggleSelectNumericFacetValueActionCreatorPayload, "numericFacet/toggleExcludeValue", never, never>;
96
96
  export interface UpdateNumericFacetValuesActionCreatorPayload {
97
97
  /**
98
- * The unique identifier of the facet (e.g., `"1"`).
98
+ * The unique identifier of the facet (for example, `"1"`).
99
99
  */
100
100
  facetId: string;
101
101
  /**
@@ -106,7 +106,7 @@ export interface UpdateNumericFacetValuesActionCreatorPayload {
106
106
  export declare const updateNumericFacetValues: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateNumericFacetValuesActionCreatorPayload], UpdateNumericFacetValuesActionCreatorPayload, "numericFacet/updateFacetValues", import("@reduxjs/toolkit").SerializedError | null, never>;
107
107
  export interface UpdateNumericFacetSortCriterionActionCreatorPayload {
108
108
  /**
109
- * The unique identifier of the facet (e.g., `"1"`).
109
+ * The unique identifier of the facet (for example, `"1"`).
110
110
  */
111
111
  facetId: string;
112
112
  /**
@@ -13,7 +13,7 @@ export interface FieldActionCreators {
13
13
  /**
14
14
  * Registers the fields to include in the query response.
15
15
  *
16
- * @param fields - The target fields (e.g., ["field1", "field2"]).
16
+ * @param fields - The target fields (for example, ["field1", "field2"]).
17
17
  * @returns A dispatchable action.
18
18
  */
19
19
  registerFieldsToInclude(fields: string[]): PayloadAction<string[]>;
@@ -60,8 +60,9 @@ export declare const streamAnswer: import("@reduxjs/toolkit").AsyncThunk<void, S
60
60
  * instead of the regular search pipeline.
61
61
  *
62
62
  * Flow:
63
- * 1. Construct the Answer API query parameters based on the current state.
64
- * 2. Fetch a new answer from the Answer API using the provided configuration.
63
+ * 1. Reset the current generated answer state.
64
+ * 2. Construct the Answer API query parameters based on the current state.
65
+ * 3. Fetch a new answer from the Answer API using the provided configuration.
65
66
  */
66
67
  export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
67
68
  state: StreamAnswerAPIState;
@@ -75,6 +75,17 @@ export declare const streamAnswerAPIStateMockWithDictionaryFieldContext: StreamA
75
75
  export declare const streamAnswerAPIStateMockWithExcerptLength: StreamAnswerAPIState;
76
76
  export declare const streamAnswerAPIStateMockWithQuerySyntaxEnabled: StreamAnswerAPIState;
77
77
  export declare const streamAnswerAPIStateMockWithCaseContextIncluded: StreamAnswerAPIState;
78
+ export declare const streamAnswerAPIStateMockWithoutContext: StreamAnswerAPIState;
79
+ export declare const streamAnswerAPIStateMockWithLegacyDidYouMean: StreamAnswerAPIState;
80
+ export declare const streamAnswerAPIStateMockWithNextDidYouMeanAutoCorrect: StreamAnswerAPIState;
81
+ export declare const streamAnswerAPIStateMockWithNextDidYouMeanNoAutoCorrect: StreamAnswerAPIState;
82
+ export declare const streamAnswerAPIStateMockWithFieldsToInclude: StreamAnswerAPIState;
83
+ export declare const streamAnswerAPIStateMockWithoutFields: StreamAnswerAPIState;
84
+ export declare const streamAnswerAPIStateMockWithDebugTrue: StreamAnswerAPIState;
85
+ export declare const streamAnswerAPIStateMockWithDebugFalse: StreamAnswerAPIState;
86
+ export declare const streamAnswerAPIStateMockWithDebugUndefined: StreamAnswerAPIState;
87
+ export declare const streamAnswerAPIStateMockWithSortableFacets: StreamAnswerAPIState;
88
+ export declare const streamAnswerAPIStateMockWithoutAnyFacets: StreamAnswerAPIState;
78
89
  export declare const expectedStreamAnswerAPIParam: {
79
90
  q: string;
80
91
  aq: string;
@@ -8,7 +8,7 @@ export interface InstantItemsCache {
8
8
  }
9
9
  export type InstantItemsState<Cache> = Record<string, {
10
10
  /**
11
- * The basic query expression (e.g., `acme tornado seeds`).
11
+ * The basic query expression (for example, `acme tornado seeds`).
12
12
  */
13
13
  q: string;
14
14
  /**
@@ -1,25 +1,3 @@
1
- export declare const selectPipeline: ((state: {
1
+ export declare const selectPipeline: (state: {
2
2
  pipeline?: string;
3
- }) => string | undefined) & {
4
- clearCache: () => void;
5
- resultsCount: () => number;
6
- resetResultsCount: () => void;
7
- } & {
8
- resultFunc: (resultFuncArgs_0: string | undefined) => string | undefined;
9
- memoizedResultFunc: ((resultFuncArgs_0: string | undefined) => string | undefined) & {
10
- clearCache: () => void;
11
- resultsCount: () => number;
12
- resetResultsCount: () => void;
13
- };
14
- lastResult: () => string | undefined;
15
- dependencies: [(state: {
16
- pipeline?: string;
17
- }) => string | undefined];
18
- recomputations: () => number;
19
- resetRecomputations: () => void;
20
- dependencyRecomputations: () => number;
21
- resetDependencyRecomputations: () => void;
22
- } & {
23
- argsMemoize: typeof import("reselect").weakMapMemoize;
24
- memoize: typeof import("reselect").weakMapMemoize;
25
- };
3
+ }) => string | undefined;
@@ -1,10 +1,10 @@
1
1
  export interface UpdateQueryActionCreatorPayload {
2
2
  /**
3
- * The basic query expression (e.g., `acme tornado seeds`).
3
+ * The basic query expression (for example, `acme tornado seeds`).
4
4
  */
5
5
  q?: string;
6
6
  /**
7
- * Whether to interpret advanced [Coveo Cloud query syntax](https://docs.coveo.com/en/1814/) in the query.
7
+ * Whether to interpret advanced [Coveo query syntax](https://docs.coveo.com/en/1552/) in the query.
8
8
  */
9
9
  enableQuerySyntax?: boolean;
10
10
  }
@@ -1,51 +1,7 @@
1
1
  import type { QueryState } from './query-state.js';
2
- export declare const selectQuery: ((state: {
2
+ export declare const selectQuery: (state: {
3
3
  query?: QueryState;
4
- }) => QueryState | undefined) & {
5
- clearCache: () => void;
6
- resultsCount: () => number;
7
- resetResultsCount: () => void;
8
- } & {
9
- resultFunc: (resultFuncArgs_0: QueryState | undefined) => QueryState | undefined;
10
- memoizedResultFunc: ((resultFuncArgs_0: QueryState | undefined) => QueryState | undefined) & {
11
- clearCache: () => void;
12
- resultsCount: () => number;
13
- resetResultsCount: () => void;
14
- };
15
- lastResult: () => QueryState | undefined;
16
- dependencies: [(state: {
17
- query?: QueryState;
18
- }) => QueryState | undefined];
19
- recomputations: () => number;
20
- resetRecomputations: () => void;
21
- dependencyRecomputations: () => number;
22
- resetDependencyRecomputations: () => void;
23
- } & {
24
- argsMemoize: typeof import("reselect").weakMapMemoize;
25
- memoize: typeof import("reselect").weakMapMemoize;
26
- };
27
- export declare const selectEnableQuerySyntax: ((state: {
4
+ }) => QueryState | undefined;
5
+ export declare const selectEnableQuerySyntax: (state: {
28
6
  query?: QueryState;
29
- }) => boolean | undefined) & {
30
- clearCache: () => void;
31
- resultsCount: () => number;
32
- resetResultsCount: () => void;
33
- } & {
34
- resultFunc: (resultFuncArgs_0: boolean | undefined) => boolean | undefined;
35
- memoizedResultFunc: ((resultFuncArgs_0: boolean | undefined) => boolean | undefined) & {
36
- clearCache: () => void;
37
- resultsCount: () => number;
38
- resetResultsCount: () => void;
39
- };
40
- lastResult: () => boolean | undefined;
41
- dependencies: [(state: {
42
- query?: QueryState;
43
- }) => boolean | undefined];
44
- recomputations: () => number;
45
- resetRecomputations: () => void;
46
- dependencyRecomputations: () => number;
47
- resetDependencyRecomputations: () => void;
48
- } & {
49
- argsMemoize: typeof import("reselect").weakMapMemoize;
50
- memoize: typeof import("reselect").weakMapMemoize;
51
- };
7
+ }) => boolean | undefined;
@@ -1,10 +1,10 @@
1
1
  export interface QueryState {
2
2
  /**
3
- * The basic query expression (e.g., `acme tornado seeds`).
3
+ * The basic query expression (for example, `acme tornado seeds`).
4
4
  */
5
5
  q: string;
6
6
  /**
7
- * Whether to interpret advanced [Coveo Cloud query syntax](https://docs.coveo.com/en/1814/) in the query.
7
+ * Whether to interpret advanced [Coveo query syntax](https://docs.coveo.com/en/1552/) in the query.
8
8
  */
9
9
  enableQuerySyntax: boolean;
10
10
  }
@@ -5,11 +5,11 @@ import type { ConfigurationSection, ContextSection, PipelineSection, QuerySetSec
5
5
  export type StateNeededByQuerySuggest = ConfigurationSection & QuerySuggestionSection & QuerySetSection & Partial<ContextSection & PipelineSection & SearchHubSection>;
6
6
  export interface RegisterQuerySuggestActionCreatorPayload {
7
7
  /**
8
- * A unique identifier for the new query suggest entity (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
8
+ * A unique identifier for the new query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
9
9
  */
10
10
  id: string;
11
11
  /**
12
- * The number of query suggestions to request from Coveo ML (e.g., `3`).
12
+ * The number of query suggestions to request from Coveo ML (for example, `3`).
13
13
  *
14
14
  * @defaultValue `5`.
15
15
  */
@@ -23,25 +23,25 @@ export declare const unregisterQuerySuggest: import("@reduxjs/toolkit").ActionCr
23
23
  }, "querySuggest/unregister", never, never>;
24
24
  export interface SelectQuerySuggestionActionCreatorPayload {
25
25
  /**
26
- * The unique identifier of the target query suggest entity (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
26
+ * The unique identifier of the target query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
27
27
  */
28
28
  id: string;
29
29
  /**
30
- * The selected query suggestion (e.g., `coveo`).
30
+ * The selected query suggestion (for example, `coveo`).
31
31
  */
32
32
  expression: string;
33
33
  }
34
34
  export declare const selectQuerySuggestion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SelectQuerySuggestionActionCreatorPayload], SelectQuerySuggestionActionCreatorPayload, "querySuggest/selectSuggestion", never, never>;
35
35
  export interface ClearQuerySuggestActionCreatorPayload {
36
36
  /**
37
- * The unique identifier of the target query suggest entity (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
37
+ * The unique identifier of the target query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
38
38
  */
39
39
  id: string;
40
40
  }
41
41
  export declare const clearQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: ClearQuerySuggestActionCreatorPayload], ClearQuerySuggestActionCreatorPayload, "querySuggest/clear", never, never>;
42
42
  export interface FetchQuerySuggestionsActionCreatorPayload {
43
43
  /**
44
- * The unique identifier of the target query suggest entity (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
44
+ * The unique identifier of the target query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`). Usually, this will be the ID of the search box controller that requests the query suggestions.
45
45
  */
46
46
  id: string;
47
47
  }
@@ -2,7 +2,7 @@ import type { QuerySuggestCompletion } from '../../api/search/query-suggest/quer
2
2
  import type { SearchAPIErrorWithStatusCode } from '../../api/search/search-api-error-response.js';
3
3
  export interface QuerySuggestState {
4
4
  /**
5
- * The unique identifier of the query suggest entity (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`).
5
+ * The unique identifier of the query suggest entity (for example, `b953ab2e-022b-4de4-903f-68b2c0682942`).
6
6
  */
7
7
  id: string;
8
8
  /**
@@ -18,7 +18,7 @@ export interface QuerySuggestState {
18
18
  */
19
19
  partialQueries: string[];
20
20
  /**
21
- * The number of query suggestions requested from Coveo ML (e.g., `3`).
21
+ * The number of query suggestions requested from Coveo ML (for example, `3`).
22
22
  */
23
23
  count: number;
24
24
  /**
@@ -5,7 +5,7 @@ export interface QuestionAnsweringRelatedQuestionState extends QuestionAnswerDoc
5
5
  */
6
6
  expanded: boolean;
7
7
  /**
8
- * The unique identifier for this question & answer.
8
+ * The unique identifier for this question and answer.
9
9
  */
10
10
  questionAnswerId: string;
11
11
  }
@@ -27,7 +27,7 @@ export interface QuestionAnsweringState {
27
27
  */
28
28
  feedbackModalOpen: boolean;
29
29
  /**
30
- * The unique identifier for this question & answer.
30
+ * The unique identifier for this question and answer.
31
31
  */
32
32
  questionAnswerId?: string;
33
33
  relatedQuestions: QuestionAnsweringRelatedQuestionState[];
@@ -28,7 +28,7 @@ export interface RecommendationState {
28
28
  */
29
29
  searchUid: string;
30
30
  /**
31
- * The version of the A/B test that applied to the related recommendation (i.e., version A or version B).
31
+ * The version of the A/B test that applied to the related recommendation (that is, version A or version B).
32
32
  */
33
33
  splitTestRun: string;
34
34
  /**