@coveo/quantic 3.33.3 → 3.33.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/out/quantic-docs.json +13 -13
- package/force-app/main/default/lwc/quanticCategoryFacet/quanticCategoryFacet.js +1 -1
- package/force-app/main/default/lwc/quanticCitation/__tests__/quanticCitation.test.js +142 -3
- package/force-app/main/default/lwc/quanticCitation/quanticCitation.html +10 -4
- package/force-app/main/default/lwc/quanticCitation/quanticCitation.js +72 -31
- package/force-app/main/default/lwc/quanticFacet/quanticFacet.js +1 -1
- package/force-app/main/default/lwc/quanticHeading/quanticHeading.js +1 -1
- package/force-app/main/default/lwc/quanticHeadlessLoader/quanticHeadlessLoader.js +4 -1
- package/force-app/main/default/lwc/quanticResultsPerPage/quanticResultsPerPage.js +1 -1
- package/force-app/main/default/lwc/quanticSmartSnippet/e2e/quanticSmartSnippet.e2e.ts +4 -28
- package/force-app/main/default/lwc/quanticSummary/quanticSummary.js +1 -1
- package/force-app/main/default/lwc/quanticTimeframe/quanticTimeframe.js +2 -2
- package/force-app/main/default/lwc/quanticUtils/facetDependenciesUtils.js +2 -2
- package/force-app/main/default/lwc/quanticUtils/quanticUtils.js +4 -4
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/product.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/date/date-format.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/plan/plan-response.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search/stemming.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/case-assist-engine/case-assist-engine-configuration.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-engine/commerce-engine-configuration.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/engine-configuration.d.ts +7 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/insight-engine/insight-engine-configuration.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/recommendation-engine/recommendation-engine-configuration.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/search-engine-configuration.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/instant-products/headless-instant-products.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/headless-product-listing.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recent-queries-list/headless-recent-queries-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/headless-search.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-context.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facet-manager/headless-core-facet-manager.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/category-facet/headless-core-category-facet.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-facet.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/pager/headless-core-pager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/query-error/headless-core-query-error.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/recent-queries-list/headless-core-recent-queries-list.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/result-list/headless-core-result-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-box/headless-core-search-box-options.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/status/headless-core-status.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/tab/headless-core-tab.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-query-trigger.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-redirection-trigger.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/category-facet/headless-category-field-suggestions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/field-suggestions/facet/headless-field-suggestions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/history-manager/headless-history-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/quickview/headless-quickview.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recommendation/headless-recommendation.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/relevance-inspector/headless-relevance-inspector.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/result-list/headless-interactive-result.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/standalone-search-box/headless-standalone-search-box.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/static-filter-value.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/url-manager/headless-url-manager.d.ts +5 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-queries-state.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-actions.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-analytics-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-input/case-input-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/configuration/configuration-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/core-facet/core-facet-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/location-facet/location-facet-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/manual-numeric-facet-selectors.d.ts +1 -21
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/numeric-facet-actions.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-selectors.d.ts +6 -126
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-selectors.d.ts +6 -160
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query/query-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-selectors.d.ts +2 -42
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +7 -181
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-actions.d.ts +13 -13
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-selectors.d.ts +4 -48
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-state.d.ts +5 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/context/context-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/context/context-selector.d.ts +2 -24
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/ranking-info-parser.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/dictionary-field-context/dictionary-field-context-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/did-you-mean/did-you-mean-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/did-you-mean/did-you-mean-selectors.d.ts +1 -21
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/excerpt-length/excerpt-length-selectors.d.ts +2 -24
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facet-options/facet-options-actions-loader.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-set-actions.d.ts +5 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-actions.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/date-facet-actions.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/numeric-facet-actions.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/fields/fields-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-mocks.d.ts +11 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/instant-items/instant-items-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/pipeline/select-pipeline.d.ts +2 -24
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-actions.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-selectors.d.ts +4 -48
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-state.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-actions.d.ts +6 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-state.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-state.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/recommendation/recommendation-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-hub/search-hub-selectors.d.ts +2 -24
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort-criteria/criteria-parser.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort-criteria/sort-criteria-selectors.d.ts +2 -24
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/static-filter-set/static-filter-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/static-filter-set/static-filter-set-state.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/tab-set/tab-set-actions-loader.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/tab-set/tab-set-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts +9 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/static-filter/headless-static-filter.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +75 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +52 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/engine.d.ts +53 -0
- 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
- 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
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/controllers/static-filter/headless-static-filter.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/engine/search-engine.ssr.d.ts +17 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/factories/standalone-static-state-factory.d.ts +9 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/types/engine.d.ts +4 -0
- package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
- package/package.json +3 -3
|
@@ -4,24 +4,24 @@ import type { PlatformEnvironment } from '../../utils/url-utils.js';
|
|
|
4
4
|
import { type CoveoFramework } from '../../utils/version.js';
|
|
5
5
|
export interface UpdateBasicConfigurationActionCreatorPayload {
|
|
6
6
|
/**
|
|
7
|
-
* The access token to use to authenticate requests against the Coveo
|
|
7
|
+
* 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.
|
|
8
8
|
*/
|
|
9
9
|
accessToken?: string;
|
|
10
10
|
/**
|
|
11
11
|
* The environment in which the organization is hosted.
|
|
12
12
|
*
|
|
13
|
-
* The `dev` and `stg` environments are only available internally for Coveo employees (
|
|
13
|
+
* The `dev` and `stg` environments are only available internally for Coveo employees (for example, Professional Services).
|
|
14
14
|
*/
|
|
15
15
|
environment?: PlatformEnvironment;
|
|
16
16
|
/**
|
|
17
|
-
* The unique identifier of the target Coveo
|
|
17
|
+
* The unique identifier of the target Coveo organization (for example, `mycoveocloudorganizationg8tp8wu3`)
|
|
18
18
|
*/
|
|
19
19
|
organizationId?: string;
|
|
20
20
|
}
|
|
21
21
|
export declare const updateBasicConfiguration: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: UpdateBasicConfigurationActionCreatorPayload], UpdateBasicConfigurationActionCreatorPayload, "configuration/updateBasicConfiguration", never, never>;
|
|
22
22
|
export interface UpdateSearchConfigurationActionCreatorPayload {
|
|
23
23
|
/**
|
|
24
|
-
* The base URL to use to proxy Coveo search requests (
|
|
24
|
+
* The base URL to use to proxy Coveo search requests (for example, `https://example.com/search`).
|
|
25
25
|
*
|
|
26
26
|
* This is an advanced option that you only set if you proxy Coveo searchrequests through your own
|
|
27
27
|
* server. In most cases, you should not set this option.
|
|
@@ -30,11 +30,11 @@ export interface UpdateSearchConfigurationActionCreatorPayload {
|
|
|
30
30
|
*/
|
|
31
31
|
proxyBaseUrl?: string;
|
|
32
32
|
/**
|
|
33
|
-
* The name of the query pipeline to use for the query (
|
|
33
|
+
* The name of the query pipeline to use for the query (for example, `External Search`).
|
|
34
34
|
*/
|
|
35
35
|
pipeline?: string;
|
|
36
36
|
/**
|
|
37
|
-
* The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates (
|
|
37
|
+
* The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates (for example, `ExternalSearch`).
|
|
38
38
|
*/
|
|
39
39
|
searchHub?: string;
|
|
40
40
|
/**
|
|
@@ -66,15 +66,15 @@ export interface UpdateAnalyticsConfigurationActionCreatorPayload {
|
|
|
66
66
|
*/
|
|
67
67
|
originContext?: string;
|
|
68
68
|
/**
|
|
69
|
-
* The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab from which the usage analytics event originates (
|
|
69
|
+
* The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab from which the usage analytics event originates (for example, `All`).
|
|
70
70
|
*/
|
|
71
71
|
originLevel2?: string;
|
|
72
72
|
/**
|
|
73
|
-
* The origin level 3 usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface that’s making the request (
|
|
73
|
+
* The origin level 3 usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface that’s making the request (for example, `https://connect.coveo.com/s/`).
|
|
74
74
|
*/
|
|
75
75
|
originLevel3?: string;
|
|
76
76
|
/**
|
|
77
|
-
* The base URL to use to proxy Coveo analytics requests (
|
|
77
|
+
* The base URL to use to proxy Coveo analytics requests (for example, `https://example.com/analytics`).
|
|
78
78
|
*
|
|
79
79
|
* This is an advanced option that you only set if you proxy Coveo analytics requests through your own
|
|
80
80
|
* server. In most cases, you should not set this option.
|
|
@@ -109,8 +109,8 @@ export interface UpdateAnalyticsConfigurationActionCreatorPayload {
|
|
|
109
109
|
trackingId?: string;
|
|
110
110
|
/**
|
|
111
111
|
* The analytics client to use.
|
|
112
|
-
* - `legacy`: The legacy analytics client,
|
|
113
|
-
* - `next`: The next analytics client,
|
|
112
|
+
* - `legacy`: The legacy analytics client, that is, the Coveo Analytics.js library.
|
|
113
|
+
* - `next`: The next analytics client, that is, the Coveo Event Protocol with the Relay library.
|
|
114
114
|
*
|
|
115
115
|
* @default 'next'
|
|
116
116
|
*/
|
|
@@ -128,14 +128,14 @@ export declare const disableAnalytics: import("@reduxjs/toolkit").ActionCreatorW
|
|
|
128
128
|
export declare const enableAnalytics: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"configuration/analytics/enable">;
|
|
129
129
|
export interface SetOriginLevel2ActionCreatorPayload {
|
|
130
130
|
/**
|
|
131
|
-
* The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab (
|
|
131
|
+
* The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab (for example, `All`).
|
|
132
132
|
*/
|
|
133
133
|
originLevel2: string;
|
|
134
134
|
}
|
|
135
135
|
export declare const setOriginLevel2: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetOriginLevel2ActionCreatorPayload], SetOriginLevel2ActionCreatorPayload, "configuration/analytics/originlevel2", never, never>;
|
|
136
136
|
export interface SetOriginLevel3ActionCreatorPayload {
|
|
137
137
|
/**
|
|
138
|
-
* The origin level 3 usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface (
|
|
138
|
+
* The origin level 3 usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface (for example, `https://connect.coveo.com/s/`).
|
|
139
139
|
*/
|
|
140
140
|
originLevel3: string;
|
|
141
141
|
}
|
|
@@ -1,51 +1,7 @@
|
|
|
1
1
|
import type { ConfigurationState } from './configuration-state.js';
|
|
2
|
-
export declare const selectLocale: (
|
|
2
|
+
export declare const selectLocale: (state: {
|
|
3
3
|
configuration: ConfigurationState;
|
|
4
|
-
}) => string
|
|
5
|
-
|
|
6
|
-
resultsCount: () => number;
|
|
7
|
-
resetResultsCount: () => void;
|
|
8
|
-
} & {
|
|
9
|
-
resultFunc: (resultFuncArgs_0: string) => string;
|
|
10
|
-
memoizedResultFunc: ((resultFuncArgs_0: string) => string) & {
|
|
11
|
-
clearCache: () => void;
|
|
12
|
-
resultsCount: () => number;
|
|
13
|
-
resetResultsCount: () => void;
|
|
14
|
-
};
|
|
15
|
-
lastResult: () => string;
|
|
16
|
-
dependencies: [(state: {
|
|
17
|
-
configuration: ConfigurationState;
|
|
18
|
-
}) => string];
|
|
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 selectTimezone: ((state: {
|
|
4
|
+
}) => string;
|
|
5
|
+
export declare const selectTimezone: (state: {
|
|
28
6
|
configuration: ConfigurationState;
|
|
29
|
-
}) => string
|
|
30
|
-
clearCache: () => void;
|
|
31
|
-
resultsCount: () => number;
|
|
32
|
-
resetResultsCount: () => void;
|
|
33
|
-
} & {
|
|
34
|
-
resultFunc: (resultFuncArgs_0: string) => string;
|
|
35
|
-
memoizedResultFunc: ((resultFuncArgs_0: string) => string) & {
|
|
36
|
-
clearCache: () => void;
|
|
37
|
-
resultsCount: () => number;
|
|
38
|
-
resetResultsCount: () => void;
|
|
39
|
-
};
|
|
40
|
-
lastResult: () => string;
|
|
41
|
-
dependencies: [(state: {
|
|
42
|
-
configuration: ConfigurationState;
|
|
43
|
-
}) => string];
|
|
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
|
+
}) => string;
|
|
@@ -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
|
|
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 (
|
|
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
|
|
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
|
-
* (
|
|
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
|
-
* (
|
|
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 (
|
|
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: (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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: (
|
|
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: (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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 (
|
|
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.
|
|
64
|
-
* 2.
|
|
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;
|
|
@@ -1,25 +1,3 @@
|
|
|
1
|
-
export declare const selectPipeline: (
|
|
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 (
|
|
3
|
+
* The basic query expression (for example, `acme tornado seeds`).
|
|
4
4
|
*/
|
|
5
5
|
q?: string;
|
|
6
6
|
/**
|
|
7
|
-
* Whether to interpret advanced [Coveo
|
|
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
|
}
|