@coveo/quantic 3.27.0-pre.e8e95b2dbe → 3.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/base-analytics.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/coveo.analytics/history-store.d.ts +1 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-client.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-params.d.ts +5 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +11 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-response.d.ts +2 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/common/trigger.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/generated-answer/generated-answer-client.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/generated-answer/generated-answer-event-payload.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +8 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +119 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/platform-client.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/fields/fields-response.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts +7 -20
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-api-client.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +5 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +5 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-response.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-api-client.d.ts +5 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/common.d.ts +9 -12
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/core-engine.d.ts +4 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/from-build-result.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/search-engine/jwt-reducer.d.ts +0 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/build.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/common.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/fetch-static-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/hydrate-static-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/headless-core-commerce-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-category-field-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-view/headless-product-view.ssr.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search-box/headless-search-box.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/standalone-search-box/headless-standalone-search-box.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-context-reserved-keys.d.ts +1 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-context.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/did-you-mean/headless-core-did-you-mean.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/_common/facet-option-definitions.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/facet/headless-core-facet.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/date-facet/headless-date-facet-options.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/headless-core-range-facet.d.ts +7 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-facet.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/facets/range-facet/numeric-facet/headless-numeric-facet-options.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/folded-result-list/headless-core-folded-result-list.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-generated-answer.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-interactive-citation.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-searchapi-generated-answer.d.ts +2 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-box/headless-core-search-box-options.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/search-parameter-manager/headless-core-search-parameter-manager.d.ts +0 -5
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet/headless-core-smart-snippet.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/triggers/headless-core-notify-trigger.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/automatic-facet/headless-automatic-facet.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/category-facet/headless-category-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/category-facet/headless-insight-category-facet.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-facet.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/generated-answer/headless-insight-generated-answer.d.ts +1 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet/headless-insight-smart-snippet-interactive-inline-links.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-interactive-questions.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/instant-results/instant-results-options.d.ts +1 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-queries-list/headless-recent-queries-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/recent-results-list/headless-recent-results-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet/headless-smart-snippet-interactive-inline-links.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-interactive-questions.d.ts +4 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/tab-manager/headless-tab-manager.ssr.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-notify-trigger.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-notify-trigger.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-redirection-trigger.ssr.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-queries-state.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-actions.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +11 -17
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/legacy-search-action-cause.d.ts +1 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-actions.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions.d.ts +104 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-assist-configuration/case-assist-configuration-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-actions.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-field/case-field-state.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-input/case-input-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/commerce-facet-search-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/facet-set-reducers.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/interfaces/request.d.ts +2 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-set/interfaces/response.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/numeric-facet/manual-numeric-facet-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/pagination/pagination-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-selectors.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.ssr.d.ts +1 -23
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-templates/product-templates-helpers.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recent-queries/recent-queries-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +2 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions.d.ts +3 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +0 -21
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/standalone-search-box-set-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-state.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/ranking-info-parser.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/document-suggestion/document-suggestion-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/category-facet-set/category-facet-validate-payload.d.ts +0 -9
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-insight-analytics-actions.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/facet-set/facet-set-insight-utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/generic/facet-reducer-helpers.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/date-facet-set/interfaces/response.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/options.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/range-facet.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/request.d.ts +1 -11
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/range-facet-utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/numeric-facet-set/interfaces/response.d.ts +3 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/folding/folding-analytics-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts +0 -33
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-configuration/insight-configuration-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-search/insight-search-actions.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-user-actions/insight-user-actions-actions.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/insight-user-actions/insight-user-actions-preprocessing.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/instant-results/instant-results-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/query-suggest/query-suggest-actions.d.ts +0 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/result/result-insight-analytics-actions.d.ts +52 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions-thunk-processor.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions.d.ts +0 -82
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions-thunk-processor.d.ts +3 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +0 -65
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-actions.d.ts +0 -4
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-serializer.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/standalone-search-box-set/standalone-search-box-set-actions.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/templates/templates-manager.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts +2 -0
- package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +1 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/state/insight-app-state.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-commerce-api-request.d.ts +1 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-engine-v2.d.ts +0 -8
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-request.d.ts +8 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/fetch.d.ts +2 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/url-utils.d.ts +2 -1
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/utils.d.ts +0 -1
- package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
- package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
- package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
- package/package.json +6 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.ssr.d.ts +0 -7
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-listing/utils/load-product-listing-reducers.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/search/utils/load-search-reducers.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts +0 -32
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-core-internal-context.d.ts +0 -31
- package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/headless-strict-context-factory.d.ts +0 -13
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/facets/range-facets/generic/interfaces/response.d.ts +0 -6
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-actions-loader.d.ts +0 -35
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-actions.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-slice.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/features/sort/sort-state.d.ts +0 -3
- package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-insight-api-client.d.ts +0 -2
- package/force-app/main/default/staticresources/coveoheadless/definitions/utils/fetch-event-source/index.d.ts +0 -2
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ControllersMap } from '../../ssr-engine/types/common.js';
|
|
2
2
|
import type { SSRCommerceEngine } from '../factories/build-factory.js';
|
|
3
3
|
import type { EngineDefinitionBuildResult } from './common.js';
|
|
4
|
-
|
|
4
|
+
interface FromBuildResultOptions<TControllers extends ControllersMap> {
|
|
5
5
|
/**
|
|
6
6
|
* The build result of the engine
|
|
7
7
|
*/
|
|
@@ -16,3 +16,4 @@ export interface FromBuildResultOptions<TControllers extends ControllersMap> {
|
|
|
16
16
|
allowedRecommendationKeys?: string[];
|
|
17
17
|
}
|
|
18
18
|
export type FromBuildResult<TControllers extends ControllersMap, TOptions, TReturn> = (options: FromBuildResultOptions<TControllers> & TOptions) => Promise<TReturn>;
|
|
19
|
+
export {};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { CoreEngine, CoreEngineNext } from '../../engine.js';
|
|
2
2
|
import type { ControllersMap, ControllersPropsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, OptionsExtender, OptionsTuple } from './common.js';
|
|
3
|
-
|
|
3
|
+
interface BuildOptions<TEngineOptions> {
|
|
4
4
|
extend?: OptionsExtender<TEngineOptions>;
|
|
5
5
|
}
|
|
6
6
|
export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineDefinitionBuildResult<TEngine, TControllersMap>>;
|
|
7
|
+
export {};
|
|
@@ -9,7 +9,7 @@ export type HasRequiredKeys<TObject> = TObject extends {} ? {
|
|
|
9
9
|
export type HasOptionalKeys<TObject> = TObject extends {} ? {
|
|
10
10
|
[K in keyof TObject]-?: {} extends Pick<TObject, K> ? K : never;
|
|
11
11
|
}[keyof TObject] extends never ? false : true : boolean;
|
|
12
|
-
|
|
12
|
+
type ExtractRequiredOptions<TOptions> = {
|
|
13
13
|
[TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
|
|
14
14
|
};
|
|
15
15
|
export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
|
|
@@ -20,7 +20,7 @@ export interface ControllersPropsMap {
|
|
|
20
20
|
export interface ControllersMap {
|
|
21
21
|
[customName: string]: Controller;
|
|
22
22
|
}
|
|
23
|
-
|
|
23
|
+
interface ControllerStaticState<TState> {
|
|
24
24
|
state: TState;
|
|
25
25
|
}
|
|
26
26
|
export interface ControllerStaticStateMap {
|
|
@@ -77,3 +77,4 @@ export type InferControllerStaticStateMapFromControllers<TControllers extends Co
|
|
|
77
77
|
export type EngineDefinitionControllersPropsOption<TControllersPropsMap extends ControllersPropsMap> = HasKeys<TControllersPropsMap> extends false ? {} : {
|
|
78
78
|
controllers: TControllersPropsMap;
|
|
79
79
|
};
|
|
80
|
+
export {};
|
|
@@ -2,7 +2,7 @@ import type { UnknownAction } from '@reduxjs/toolkit';
|
|
|
2
2
|
import type { CoreEngine, CoreEngineNext } from '../../engine.js';
|
|
3
3
|
import type { ControllerStaticStateMap, ControllersMap, ControllersPropsMap, EngineDefinitionControllersPropsOption, EngineStaticState, OptionsTuple } from './common.js';
|
|
4
4
|
import type { FromBuildResult } from './from-build-result.js';
|
|
5
|
-
|
|
5
|
+
type FetchStaticStateOptions = {};
|
|
6
6
|
export type FetchStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = {
|
|
7
7
|
/**
|
|
8
8
|
* Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
|
|
@@ -12,3 +12,4 @@ export type FetchStaticState<TEngine extends CoreEngine | CoreEngineNext, TContr
|
|
|
12
12
|
(...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
|
|
13
13
|
fromBuildResult: FromBuildResult<TEngine, TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
|
|
14
14
|
};
|
|
15
|
+
export {};
|
|
@@ -2,7 +2,7 @@ import type { UnknownAction } from '@reduxjs/toolkit';
|
|
|
2
2
|
import type { CoreEngine, CoreEngineNext } from '../../engine.js';
|
|
3
3
|
import type { ControllersMap, ControllersPropsMap, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple } from './common.js';
|
|
4
4
|
import type { FromBuildResult } from './from-build-result.js';
|
|
5
|
-
|
|
5
|
+
interface HydrateStaticStateOptions<TSearchAction> {
|
|
6
6
|
searchAction: TSearchAction;
|
|
7
7
|
}
|
|
8
8
|
export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = {
|
|
@@ -14,3 +14,4 @@ export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TCon
|
|
|
14
14
|
(...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<HydratedState<TEngine, TControllers>>;
|
|
15
15
|
fromBuildResult: FromBuildResult<TEngine, TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<TEngine, TControllers>>;
|
|
16
16
|
};
|
|
17
|
+
export {};
|
|
@@ -52,7 +52,7 @@ export interface FacetGenerator extends Omit<CSRFacetGenerator, 'state' | 'facet
|
|
|
52
52
|
export interface FacetGeneratorOptions {
|
|
53
53
|
props: FacetGeneratorProps;
|
|
54
54
|
}
|
|
55
|
-
|
|
55
|
+
interface FacetGeneratorProps {
|
|
56
56
|
solutionType: SolutionType;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -18,7 +18,7 @@ export interface FacetControllerType<T extends FacetType> {
|
|
|
18
18
|
*
|
|
19
19
|
* The configurable `CoreCommerceFacet` properties used internally.
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
interface CoreCommerceFacetProps {
|
|
22
22
|
options: CoreCommerceFacetOptions;
|
|
23
23
|
}
|
|
24
24
|
export interface CoreCommerceFacetOptions {
|
|
@@ -89,7 +89,6 @@ export type CoreCommerceFacetState<ValueResponse extends AnyFacetValueResponse>
|
|
|
89
89
|
*/
|
|
90
90
|
values: ValueResponse[];
|
|
91
91
|
};
|
|
92
|
-
export type CoreCommerceFacetBuilder = typeof buildCoreCommerceFacet;
|
|
93
92
|
export declare function buildCoreCommerceFacet<ValueRequest extends AnyFacetValueRequest, ValueResponse extends AnyFacetValueResponse>(engine: CommerceEngine, props: CoreCommerceFacetProps): {
|
|
94
93
|
toggleSelect: (selection: ValueRequest) => void;
|
|
95
94
|
toggleExclude: (selection: ValueRequest) => void;
|
|
@@ -4,7 +4,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
import type { CategoryFieldSuggestionsValue, CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
|
|
5
5
|
import type { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
|
|
6
6
|
import type { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
|
|
7
|
-
export type { CategoryFieldSuggestionsValue };
|
|
8
7
|
/**
|
|
9
8
|
* The state of the `CategoryFieldSuggestions` controller.
|
|
10
9
|
*
|
|
@@ -4,7 +4,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
4
4
|
import type { CategoryFieldSuggestionsValue, CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
|
|
5
5
|
import type { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
|
|
6
6
|
import type { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
|
|
7
|
-
export type { CategoryFieldSuggestionsValue };
|
|
8
7
|
/**
|
|
9
8
|
* The state of the `CategoryFilterSuggestions` controller.
|
|
10
9
|
*
|
|
@@ -5,7 +5,6 @@ import { type Controller } from '../../controller/headless-controller.js';
|
|
|
5
5
|
import type { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
|
|
6
6
|
import type { RegularFacetOptions } from '../core/facets/regular/headless-commerce-regular-facet.js';
|
|
7
7
|
import { type RegularFacetSearchState } from '../core/facets/regular/headless-commerce-regular-facet-search.js';
|
|
8
|
-
export type { SpecificFacetSearchResult };
|
|
9
8
|
/**
|
|
10
9
|
* The state of the `FilterSuggestions` controller.
|
|
11
10
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
|
|
2
2
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
3
3
|
import { type ProductView as BaseProductView } from './headless-product-view.js';
|
|
4
|
-
|
|
4
|
+
interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Defines a `ProductView` controller instance.
|
|
@@ -17,3 +17,4 @@ export interface ProductViewDefinition extends NonRecommendationControllerDefini
|
|
|
17
17
|
export declare function defineProductView(): ProductViewDefinition;
|
|
18
18
|
export interface ProductView extends BaseProductView, Controller {
|
|
19
19
|
}
|
|
20
|
+
export {};
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
|
|
2
|
-
import type { Delimiters, SuggestionHighlightingOptions } from '../../../utils/highlight.js';
|
|
3
2
|
import { type SearchBox as CoreSearchBox, type SearchBoxState, type Suggestion } from '../../core/search-box/headless-core-search-box.js';
|
|
4
3
|
import { type SearchBoxOptions } from './headless-search-box-options.js';
|
|
5
|
-
export type { SearchBoxOptions, SearchBoxState,
|
|
4
|
+
export type { SearchBoxOptions, SearchBoxState, Suggestion, CoreSearchBox };
|
|
6
5
|
export interface SearchBoxProps {
|
|
7
6
|
/**
|
|
8
7
|
* The `SearchBox` controller options.
|
|
@@ -2,7 +2,6 @@ import type { ListingAndStandaloneControllerWithoutProps } from '../../../app/co
|
|
|
2
2
|
import type { StandaloneSearchBoxProps } from '../../standalone-search-box/headless-standalone-search-box.js';
|
|
3
3
|
import { type StandaloneSearchBox } from './headless-standalone-search-box.js';
|
|
4
4
|
export type { StandaloneSearchBoxState } from './headless-standalone-search-box.js';
|
|
5
|
-
export type { StandaloneSearchBoxOptions } from './headless-standalone-search-box-options.js';
|
|
6
5
|
export type { StandaloneSearchBox, StandaloneSearchBoxProps };
|
|
7
6
|
export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
|
|
8
7
|
}
|
|
@@ -162,7 +162,7 @@ export type GetBreadcrumbsConfiguration<T extends AnyFacetSetState> = {
|
|
|
162
162
|
facetValuesSelector: (state: CoreEngine<ConfigurationSection & SearchSection & FacetSection & NumericFacetSection & DateFacetSection & CategoryFacetSection>['state'], facetId: string) => InferFacetSliceValueType<T>[];
|
|
163
163
|
};
|
|
164
164
|
type InferFacetSliceValueRequestType<T extends AnyFacetSetState> = T[string]['request']['currentValues'][number];
|
|
165
|
-
|
|
165
|
+
type InferFacetSliceValueType<T extends AnyFacetSetState> = InferFacetSliceValueRequestType<T> extends FacetValueRequest ? FacetValue : InferFacetSliceValueRequestType<T> extends NumericRangeRequest ? NumericFacetValue : InferFacetSliceValueRequestType<T> extends DateRangeRequest ? DateFacetValue : CategoryFacetValue;
|
|
166
166
|
export declare const getBreadcrumbs: <T extends AnyFacetSetState>(config: GetBreadcrumbsConfiguration<T>) => Breadcrumb<InferFacetSliceValueType<T>>[];
|
|
167
167
|
/**
|
|
168
168
|
* Creates a `BreadcrumbManager` controller instance.
|
|
@@ -2,12 +2,9 @@
|
|
|
2
2
|
* @todo Example reserved keys
|
|
3
3
|
*/
|
|
4
4
|
declare const ReservedContextKeys: readonly ["caseId", "caseNumber"];
|
|
5
|
-
|
|
5
|
+
type ReservedContextKey = (typeof ReservedContextKeys)[number];
|
|
6
6
|
export declare class ReservedContextKeyError extends Error {
|
|
7
7
|
constructor(key: ReservedContextKey);
|
|
8
8
|
}
|
|
9
|
-
export declare class UnreservedContextKeyError extends Error {
|
|
10
|
-
constructor(key: ReservedContextKey);
|
|
11
|
-
}
|
|
12
9
|
export declare function isReservedContextKey(contextKey: string): contextKey is ReservedContextKey;
|
|
13
10
|
export {};
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
2
2
|
import type { ContextPayload, ContextValue } from '../../../features/context/context-state.js';
|
|
3
3
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
4
|
-
export type { ContextPayload, ContextValue };
|
|
5
4
|
export interface ContextProps {
|
|
6
5
|
/**
|
|
7
6
|
* Represents the initial state of the context.
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import type { QueryCorrection
|
|
1
|
+
import type { QueryCorrection } from '../../../api/search/search/query-corrections.js';
|
|
2
2
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
3
3
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
4
|
-
export type { QueryCorrection, WordCorrection };
|
|
5
4
|
export interface DidYouMeanProps {
|
|
6
5
|
options?: DidYouMeanOptions;
|
|
7
6
|
}
|
|
@@ -96,3 +95,4 @@ export interface DidYouMeanState {
|
|
|
96
95
|
* @category DidYouMean
|
|
97
96
|
*/
|
|
98
97
|
export declare function buildCoreDidYouMean(engine: CoreEngine, props?: DidYouMeanProps): DidYouMean;
|
|
98
|
+
export {};
|
|
@@ -8,8 +8,6 @@ export declare const filterFacetCount: BooleanValue;
|
|
|
8
8
|
export declare const injectionDepth: NumberValue;
|
|
9
9
|
export declare const numberOfValues: NumberValue;
|
|
10
10
|
export declare const generateAutomaticRanges: never;
|
|
11
|
-
export declare const captions: RecordValue;
|
|
12
|
-
export declare const query: StringValue<string>;
|
|
13
11
|
export declare const facetSearch: RecordValue;
|
|
14
12
|
export declare const allowedValues: RecordValue;
|
|
15
13
|
export declare const hasBreadcrumbs: BooleanValue;
|
|
@@ -2,9 +2,9 @@ import type { CoreEngine } from '../../../../app/engine.js';
|
|
|
2
2
|
import type { FacetValueState } from '../../../../features/facets/facet-api/value.js';
|
|
3
3
|
import type { FacetSortCriterion } from '../../../../features/facets/facet-set/interfaces/request.js';
|
|
4
4
|
import { type Controller } from '../../../controller/headless-controller.js';
|
|
5
|
-
import { type FacetOptions
|
|
6
|
-
export type { FacetOptions,
|
|
7
|
-
|
|
5
|
+
import { type FacetOptions } from './headless-core-facet-options.js';
|
|
6
|
+
export type { FacetOptions, FacetValueState };
|
|
7
|
+
interface CoreFacetProps {
|
|
8
8
|
/**
|
|
9
9
|
* The options for the core `Facet` controller.
|
|
10
10
|
* */
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Schema } from '@coveo/bueno';
|
|
2
1
|
import type { CoreEngine } from '../../../../../app/engine.js';
|
|
3
2
|
import type { DateRangeRequest } from '../../../../../features/facets/range-facets/date-facet-set/interfaces/request.js';
|
|
4
3
|
import { type RangeFacetRangeAlgorithm, type RangeFacetSortCriterion } from '../../../../../features/facets/range-facets/generic/interfaces/request.js';
|
|
@@ -75,5 +74,4 @@ export interface DateFacetOptions {
|
|
|
75
74
|
*/
|
|
76
75
|
rangeAlgorithm?: RangeFacetRangeAlgorithm;
|
|
77
76
|
}
|
|
78
|
-
export declare const dateFacetOptionsSchema: Schema<Required<DateFacetOptions>>;
|
|
79
77
|
export declare function validateDateFacetOptions(engine: CoreEngine<ConfigurationSection & SearchSection & DateFacetSection>, options: DateFacetOptions): void;
|
|
@@ -23,7 +23,13 @@ export declare function buildCoreRangeFacet<T extends RangeFacetRequest, R exten
|
|
|
23
23
|
hasActiveValues: boolean;
|
|
24
24
|
isLoading: boolean;
|
|
25
25
|
enabled: boolean;
|
|
26
|
-
domain:
|
|
26
|
+
domain: {
|
|
27
|
+
end: string;
|
|
28
|
+
start: string;
|
|
29
|
+
} | {
|
|
30
|
+
end: number;
|
|
31
|
+
start: number;
|
|
32
|
+
} | undefined;
|
|
27
33
|
};
|
|
28
34
|
subscribe(listener: () => void): import("redux").Unsubscribe;
|
|
29
35
|
};
|
|
@@ -5,7 +5,7 @@ import type { NumericFacetValue } from '../../../../../features/facets/range-fac
|
|
|
5
5
|
import type { Controller } from '../../../../controller/headless-controller.js';
|
|
6
6
|
import { type NumericFacetOptions } from './headless-numeric-facet-options.js';
|
|
7
7
|
import { buildNumericRange, type NumericRangeOptions } from './numeric-range.js';
|
|
8
|
-
export type { NumericRangeOptions, NumericRangeRequest,
|
|
8
|
+
export type { NumericRangeOptions, NumericRangeRequest, NumericFacetOptions };
|
|
9
9
|
export { buildNumericRange };
|
|
10
10
|
export interface NumericFacetProps {
|
|
11
11
|
/**
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Schema } from '@coveo/bueno';
|
|
2
1
|
import type { CoreEngine } from '../../../../../app/engine.js';
|
|
3
2
|
import { type FacetResultsMustMatch } from '../../../../../features/facets/facet-api/request.js';
|
|
4
3
|
import { type RangeFacetRangeAlgorithm, type RangeFacetSortCriterion } from '../../../../../features/facets/range-facets/generic/interfaces/request.js';
|
|
@@ -85,5 +84,4 @@ export interface NumericFacetOptions {
|
|
|
85
84
|
*/
|
|
86
85
|
rangeAlgorithm?: RangeFacetRangeAlgorithm;
|
|
87
86
|
}
|
|
88
|
-
export declare const numericFacetOptionsSchema: Schema<Required<NumericFacetOptions>>;
|
|
89
87
|
export declare function validateNumericFacetOptions(engine: CoreEngine<NumericFacetSection & ConfigurationSection & SearchSection>, options: NumericFacetOptions): void;
|
|
@@ -123,7 +123,7 @@ export interface FoldedResultListState extends SearchStatusState {
|
|
|
123
123
|
*/
|
|
124
124
|
moreResultsAvailable: boolean;
|
|
125
125
|
}
|
|
126
|
-
|
|
126
|
+
interface FoldedResultAnalyticsClient {
|
|
127
127
|
logShowMoreFoldedResults: (result: Result) => ClickAction;
|
|
128
128
|
logShowLessFoldedResults: () => CustomAction;
|
|
129
129
|
}
|
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
import type { GeneratedAnswerCitation } from '../../../api/generated-answer/generated-answer-event-payload.js';
|
|
2
1
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
3
2
|
import type { CustomAction, LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
|
|
4
3
|
import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
|
|
5
4
|
import type { GeneratedAnswerState } from '../../../features/generated-answer/generated-answer-state.js';
|
|
6
5
|
import type { GeneratedResponseFormat } from '../../../features/generated-answer/generated-response-format.js';
|
|
7
6
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
8
|
-
export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, };
|
|
9
7
|
/**
|
|
10
8
|
* The `GeneratedAnswer` controller uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user.
|
|
11
9
|
*
|
|
@@ -22,7 +22,7 @@ export interface InteractiveCitationProps extends InteractiveResultCoreProps {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface InteractiveCitation extends InteractiveResultCore {
|
|
24
24
|
}
|
|
25
|
-
|
|
25
|
+
interface InteractiveCitationAnalyticsClient {
|
|
26
26
|
logOpenGeneratedAnswerSource(citationId: string): CustomAction;
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
@@ -33,3 +33,4 @@ export interface InteractiveCitationAnalyticsClient {
|
|
|
33
33
|
* @returns An `InteractiveCitation` controller instance.
|
|
34
34
|
*/
|
|
35
35
|
export declare function buildInteractiveCitationCore(engine: CoreEngine, analyticsClient: InteractiveCitationAnalyticsClient, props: InteractiveCitationProps): InteractiveCitation;
|
|
36
|
+
export {};
|
|
@@ -7,9 +7,7 @@ import type { ClientThunkExtraArguments } from '../../../app/thunk-extra-argumen
|
|
|
7
7
|
import type { ConfigurationState } from '../../../features/configuration/configuration-state.js';
|
|
8
8
|
import type { DebugSection, GeneratedAnswerSection, SearchSection } from '../../../state/state-sections.js';
|
|
9
9
|
import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from './headless-core-generated-answer.js';
|
|
10
|
-
|
|
11
|
-
}
|
|
12
|
-
export interface SearchAPIGeneratedAnswerProps extends GeneratedAnswerProps {
|
|
10
|
+
interface SearchAPIGeneratedAnswer extends GeneratedAnswer {
|
|
13
11
|
}
|
|
14
12
|
interface SubscribeStateManager {
|
|
15
13
|
engines: Record<string, {
|
|
@@ -22,7 +20,7 @@ interface SubscribeStateManager {
|
|
|
22
20
|
subscribeToSearchRequests: (engine: CoreEngine<GeneratedAnswerSection & SearchSection & DebugSection, ClientThunkExtraArguments<GeneratedAnswerAPIClient>, ConfigurationState>) => Unsubscribe;
|
|
23
21
|
}
|
|
24
22
|
export declare const subscribeStateManager: SubscribeStateManager;
|
|
25
|
-
|
|
23
|
+
interface SearchAPIGeneratedAnswerAnalyticsClient extends GeneratedAnswerAnalyticsClient {
|
|
26
24
|
}
|
|
27
25
|
/**
|
|
28
26
|
* Creates a `GeneratedAnswer` controller instance using the search API stream pattern.
|
|
@@ -32,10 +32,6 @@ export interface SearchBoxOptions {
|
|
|
32
32
|
}
|
|
33
33
|
type DefaultSearchBoxOptions = Pick<SearchBoxOptions, 'enableQuerySyntax' | 'numberOfSuggestions' | 'clearFilters'>;
|
|
34
34
|
export declare const defaultSearchBoxOptions: Required<DefaultSearchBoxOptions>;
|
|
35
|
-
export declare const openCloseDelimitersDefinition: {
|
|
36
|
-
open: StringValue<string>;
|
|
37
|
-
close: StringValue<string>;
|
|
38
|
-
};
|
|
39
35
|
export declare const searchBoxOptionDefinitions: {
|
|
40
36
|
id: StringValue<string>;
|
|
41
37
|
numberOfSuggestions: NumberValue;
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
2
|
-
import type { BaseFacetValueRequest, CurrentValues } from '../../../features/facets/facet-api/request.js';
|
|
3
|
-
import type { FacetRequest } from '../../../features/facets/facet-set/interfaces/request.js';
|
|
4
2
|
import { type SearchParameters } from '../../../features/search-parameters/search-parameter-actions.js';
|
|
5
3
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
6
|
-
export type { SearchParameters };
|
|
7
4
|
export interface SearchParameterManagerProps {
|
|
8
5
|
/**
|
|
9
6
|
* The initial state that should be applied to the `SearchParameterManager` controller.
|
|
@@ -56,5 +53,3 @@ export interface SearchParameterManagerState {
|
|
|
56
53
|
export declare function buildCoreSearchParameterManager(engine: CoreEngine, props: SearchParameterManagerProps): SearchParameterManager;
|
|
57
54
|
export declare function enrichParameters(engine: CoreEngine, parameters: SearchParameters): Required<SearchParameters>;
|
|
58
55
|
export declare function getCoreActiveSearchParameters(engine: CoreEngine): SearchParameters;
|
|
59
|
-
export declare function getSelectedValues(request: FacetRequest): string[];
|
|
60
|
-
export declare function getSelectedRangeValues(request: CurrentValues<BaseFacetValueRequest>): BaseFacetValueRequest[];
|
|
@@ -6,7 +6,6 @@ import type { SmartSnippetFeedback } from '../../../features/question-answering/
|
|
|
6
6
|
import type { QuestionAnsweringInlineLinkActionCreatorPayload, QuestionAnsweringUniqueIdentifierActionCreatorPayload } from '../../../features/question-answering/question-answering-document-id.js';
|
|
7
7
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
8
8
|
import type { InlineLink } from '../../smart-snippet/headless-smart-snippet-interactive-inline-links.js';
|
|
9
|
-
export type { QuestionAnswerDocumentIdentifier } from '../../../api/search/search/question-answering.js';
|
|
10
9
|
export interface SmartSnippetOptions {
|
|
11
10
|
/**
|
|
12
11
|
* The amount of time in milliseconds to wait before selecting the source or inline links after calling `beginDelayedSelectSource` or `beginDelayedSelectInlineLink`.
|
|
@@ -3,7 +3,6 @@ import type { Result } from '../../../api/search/search/result.js';
|
|
|
3
3
|
import type { CoreEngine } from '../../../app/engine.js';
|
|
4
4
|
import { type Controller } from '../../controller/headless-controller.js';
|
|
5
5
|
import type { SmartSnippetAnalyticsClient } from '../smart-snippet/headless-core-smart-snippet.js';
|
|
6
|
-
export type { QuestionAnswerDocumentIdentifier } from '../../../api/search/search/question-answering.js';
|
|
7
6
|
export interface SmartSnippetQuestionsListOptions {
|
|
8
7
|
/**
|
|
9
8
|
* The amount of time in milliseconds to wait before selecting the source after calling `beginDelayedSelect`.
|
|
@@ -27,10 +27,10 @@ export interface NotifyTriggerState {
|
|
|
27
27
|
*/
|
|
28
28
|
notifications: string[];
|
|
29
29
|
}
|
|
30
|
-
|
|
30
|
+
interface NotifyTriggerProps {
|
|
31
31
|
options: NotifyTriggerOptions;
|
|
32
32
|
}
|
|
33
|
-
|
|
33
|
+
interface NotifyTriggerOptions {
|
|
34
34
|
logNotifyTriggerActionCreator: () => InsightAction | LegacySearchAction;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
@@ -43,3 +43,4 @@ export interface NotifyTriggerOptions {
|
|
|
43
43
|
* @category NotifyTrigger
|
|
44
44
|
*/
|
|
45
45
|
export declare function buildCoreNotifyTrigger(engine: CoreEngine, props: NotifyTriggerProps): NotifyTrigger;
|
|
46
|
+
export {};
|
|
@@ -4,7 +4,7 @@ import type { AutomaticFacet } from '../automatic-facet-generator/headless-autom
|
|
|
4
4
|
* @internal
|
|
5
5
|
* This prop is used internally by the `AutomaticFacetGenerator` controller.
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
interface AutomaticFacetProps {
|
|
8
8
|
/**
|
|
9
9
|
* The field from which to display values in the facet.
|
|
10
10
|
*/
|
|
@@ -21,3 +21,4 @@ export interface AutomaticFacetProps {
|
|
|
21
21
|
* @returns An `AutomaticFacet` controller instance.
|
|
22
22
|
* */
|
|
23
23
|
export declare function buildAutomaticFacet(engine: SearchEngine, props: AutomaticFacetProps): AutomaticFacet;
|
|
24
|
+
export {};
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
|
|
2
|
-
import type { CategoryFacetValue } from '../../../features/facets/category-facet-set/interfaces/response.js';
|
|
3
2
|
import { type CategoryFacet, type CategoryFacetProps, type CategoryFacetSearch, type CategoryFacetSearchResult, type CategoryFacetSearchState, type CategoryFacetState, type CoreCategoryFacet, type CoreCategoryFacetState } from '../../core/facets/category-facet/headless-core-category-facet.js';
|
|
4
3
|
import type { CategoryFacetOptions, CategoryFacetSearchOptions } from '../../core/facets/category-facet/headless-core-category-facet-options.js';
|
|
5
|
-
export type {
|
|
4
|
+
export type { CategoryFacetOptions, CategoryFacetSearchOptions, CategoryFacetProps, CategoryFacet, CategoryFacetState, CategoryFacetSearch, CategoryFacetSearchState, CategoryFacetSearchResult, CoreCategoryFacet, CoreCategoryFacetState, };
|
|
6
5
|
/**
|
|
7
6
|
* Creates a `CategoryFacet` controller instance.
|
|
8
7
|
*
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { InsightEngine } from '../../../../app/insight-engine/insight-engine.js';
|
|
2
|
-
import type { SearchAction } from '../../../../features/search/search-actions.js';
|
|
3
2
|
import { type CategoryFacet, type CategoryFacetOptions, type CategoryFacetProps, type CategoryFacetSearch, type CategoryFacetSearchOptions, type CategoryFacetSearchResult, type CategoryFacetSearchState, type CategoryFacetState, type CategoryFacetValue, type CategoryFacetValueCommon, type CoreCategoryFacet, type CoreCategoryFacetState } from '../../../core/facets/category-facet/headless-core-category-facet.js';
|
|
4
3
|
export type { CategoryFacetValueCommon, CategoryFacetValue, CategoryFacetOptions, CategoryFacetSearchOptions, CategoryFacetProps, CategoryFacet, CategoryFacetState, CategoryFacetSearch, CategoryFacetSearchState, CategoryFacetSearchResult, CoreCategoryFacet, CoreCategoryFacetState, };
|
|
5
4
|
/**
|
|
@@ -13,4 +12,3 @@ export type { CategoryFacetValueCommon, CategoryFacetValue, CategoryFacetOptions
|
|
|
13
12
|
* @category CategoryFacet
|
|
14
13
|
* */
|
|
15
14
|
export declare function buildCategoryFacet(engine: InsightEngine, props: CategoryFacetProps): CategoryFacet;
|
|
16
|
-
export declare function getToggleSelectAnalyticsAction(selection: CategoryFacetValue): SearchAction;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import type { InsightEngine } from '../../../../../app/insight-engine/insight-engine.js';
|
|
2
2
|
import type { NumericRangeRequest } from '../../../../../features/facets/range-facets/numeric-facet-set/interfaces/request.js';
|
|
3
|
-
import type { NumericFacetValue } from '../../../../../features/facets/range-facets/numeric-facet-set/interfaces/response.js';
|
|
4
3
|
import { buildNumericRange, type NumericFacet, type NumericFacetOptions, type NumericFacetProps, type NumericFacetState, type NumericRangeOptions } from '../../../../core/facets/range-facet/numeric-facet/headless-core-numeric-facet.js';
|
|
5
|
-
export type { NumericRangeOptions, NumericRangeRequest,
|
|
4
|
+
export type { NumericRangeOptions, NumericRangeRequest, NumericFacetOptions, NumericFacetProps, NumericFacet, NumericFacetState, };
|
|
6
5
|
export { buildNumericRange };
|
|
7
6
|
/**
|
|
8
7
|
* Creates an insight `NumericFacet` controller instance.
|
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
import type { GeneratedAnswerCitation } from '../../../api/generated-answer/generated-answer-event-payload.js';
|
|
2
1
|
import type { InsightEngine } from '../../../app/insight-engine/insight-engine.js';
|
|
3
2
|
import type { GeneratedAnswerState } from '../../../features/generated-answer/generated-answer-state.js';
|
|
4
|
-
import type { GeneratedResponseFormat } from '../../../features/generated-answer/generated-response-format.js';
|
|
5
3
|
import type { GeneratedAnswer, GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
|
|
6
|
-
export type {
|
|
4
|
+
export type { GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerProps };
|
|
7
5
|
/**
|
|
8
6
|
* Creates an insight `GeneratedAnswer` controller instance.
|
|
9
7
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { InsightEngine } from '../../../app/insight-engine/insight-engine.js';
|
|
2
2
|
import type { InlineLink } from '../../smart-snippet/headless-smart-snippet-interactive-inline-links.js';
|
|
3
|
-
|
|
3
|
+
interface SmartSnippetInteractiveInlineLinksOptions {
|
|
4
4
|
/**
|
|
5
5
|
* The amount of time to wait before selecting the result after calling `beginDelayedSelect`.
|
|
6
6
|
*
|
|
@@ -8,13 +8,13 @@ export interface SmartSnippetInteractiveInlineLinksOptions {
|
|
|
8
8
|
*/
|
|
9
9
|
selectionDelay?: number;
|
|
10
10
|
}
|
|
11
|
-
|
|
11
|
+
interface SmartSnippetInteractiveInlineLinksProps {
|
|
12
12
|
/**
|
|
13
13
|
* The options for the result controller core.
|
|
14
14
|
*/
|
|
15
15
|
options?: SmartSnippetInteractiveInlineLinksOptions;
|
|
16
16
|
}
|
|
17
|
-
|
|
17
|
+
interface SmartSnippetInteractiveInlineLinks {
|
|
18
18
|
/**
|
|
19
19
|
* Selects the result, logging a UA event to the Coveo Platform if the result wasn't selected before.
|
|
20
20
|
*
|
|
@@ -51,3 +51,4 @@ export interface SmartSnippetInteractiveInlineLinks {
|
|
|
51
51
|
* @category SmartSnippetInteractiveInlineLinks
|
|
52
52
|
*/
|
|
53
53
|
export declare function buildSmartSnippetInteractiveInlineLinks(engine: InsightEngine, props?: SmartSnippetInteractiveInlineLinksProps): SmartSnippetInteractiveInlineLinks;
|
|
54
|
+
export {};
|
|
@@ -2,19 +2,19 @@ import type { InsightEngine } from '../../../app/insight-engine/insight-engine.j
|
|
|
2
2
|
/**
|
|
3
3
|
* @internal
|
|
4
4
|
*/
|
|
5
|
-
|
|
5
|
+
interface SmartSnippetInteractiveQuestionsOptions {
|
|
6
6
|
selectionDelay?: number;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* @internal
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
interface SmartSnippetInteractiveQuestionsProps {
|
|
12
12
|
options?: SmartSnippetInteractiveQuestionsOptions;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* @internal
|
|
16
16
|
*/
|
|
17
|
-
|
|
17
|
+
interface SmartSnippetInteractiveQuestions {
|
|
18
18
|
selectSource(questionAnswerId: string): void;
|
|
19
19
|
beginDelayedSelectSource(questionAnswerId: string): void;
|
|
20
20
|
cancelPendingSelectSource(questionAnswerId: string): void;
|
|
@@ -23,3 +23,4 @@ export interface SmartSnippetInteractiveQuestions {
|
|
|
23
23
|
* @internal
|
|
24
24
|
*/
|
|
25
25
|
export declare function buildInsightSmartSnippetInteractiveQuestions(engine: InsightEngine, props?: SmartSnippetInteractiveQuestionsProps): SmartSnippetInteractiveQuestions;
|
|
26
|
+
export {};
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { InsightEngine } from '../../../app/insight-engine/insight-engine.js';
|
|
2
2
|
import { type CoreSmartSnippetQuestionsList, type CoreSmartSnippetQuestionsListState, type SmartSnippetQuestionsListProps } from '../../core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
|
|
3
3
|
import type { InlineLink } from '../../smart-snippet/headless-smart-snippet-interactive-inline-links.js';
|
|
4
|
-
export type { QuestionAnswerDocumentIdentifier } from '../../../api/search/search/question-answering.js';
|
|
5
4
|
export type { CoreSmartSnippetQuestionsList, CoreSmartSnippetQuestionsListState, SmartSnippetQuestionsListOptions, SmartSnippetQuestionsListProps, SmartSnippetRelatedQuestion, } from '../../core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
|
|
6
5
|
/**
|
|
7
6
|
* A scoped and simplified part of the headless state that is relevant to the `SmartSnippetQuestionsList` controller.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Schema } from '@coveo/bueno';
|
|
2
2
|
export interface InstantResultOptions {
|
|
3
3
|
/**
|
|
4
4
|
* A unique identifier for the search box.
|
|
@@ -13,9 +13,4 @@ export interface InstantResultOptions {
|
|
|
13
13
|
*/
|
|
14
14
|
cacheTimeout?: number;
|
|
15
15
|
}
|
|
16
|
-
export declare const instantResultsOptionDefinitions: {
|
|
17
|
-
searchBoxId: import("@coveo/bueno").StringValue<string>;
|
|
18
|
-
maxResultsPerQuery: NumberValue;
|
|
19
|
-
cacheTimeout: NumberValue;
|
|
20
|
-
};
|
|
21
16
|
export declare const instantResultsOptionsSchema: Schema<Required<InstantResultOptions>>;
|
|
@@ -2,7 +2,7 @@ import type { InsightEngine } from '../../../app/insight-engine/insight-engine.j
|
|
|
2
2
|
import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
|
|
3
3
|
import type { GeneratedAnswerFeedback } from '../../../features/generated-answer/generated-answer-analytics-actions.js';
|
|
4
4
|
import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
|
|
5
|
-
|
|
5
|
+
interface AnswerApiGeneratedAnswer extends Omit<GeneratedAnswer, 'sendFeedback'> {
|
|
6
6
|
/**
|
|
7
7
|
* Resets the last answer.
|
|
8
8
|
*/
|
|
@@ -15,7 +15,7 @@ export interface AnswerApiGeneratedAnswer extends Omit<GeneratedAnswer, 'sendFee
|
|
|
15
15
|
}
|
|
16
16
|
interface AnswerApiGeneratedAnswerProps extends GeneratedAnswerProps {
|
|
17
17
|
}
|
|
18
|
-
|
|
18
|
+
interface SearchAPIGeneratedAnswerAnalyticsClient extends GeneratedAnswerAnalyticsClient {
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
*
|