@coveo/quantic 3.11.0 → 3.12.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.
Files changed (103) hide show
  1. package/README.md +1 -1
  2. package/docs/out/quantic-docs.json +27 -0
  3. package/force-app/main/default/lwc/quanticBreadcrumbManager/__tests__/quanticBreadcrumbManager.test.js +610 -0
  4. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/fixture.ts +76 -0
  5. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/pageObject.ts +282 -0
  6. package/force-app/main/default/lwc/quanticBreadcrumbManager/e2e/quanticBreadcrumbManager.e2e.ts +167 -0
  7. package/force-app/main/default/lwc/quanticBreadcrumbManager/quanticBreadcrumbManager.html +10 -10
  8. package/force-app/main/default/lwc/quanticBreadcrumbManager/quanticBreadcrumbManager.js +8 -8
  9. package/force-app/main/default/lwc/quanticFeedbackModalQna/templates/quanticFeedbackModalQna.html +1 -0
  10. package/force-app/main/default/lwc/quanticGeneratedAnswer/__tests__/quanticGeneratedAnswer.test.js +538 -21
  11. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/data.ts +56 -0
  12. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/fixture.ts +87 -0
  13. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/pageObject.ts +279 -0
  14. package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/quanticGeneratedAnswer.e2e.ts +178 -0
  15. package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.html +24 -10
  16. package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/retryPrompt.html +2 -2
  17. package/force-app/main/default/lwc/quanticGeneratedAnswerToggle/quanticGeneratedAnswerToggle.html +1 -1
  18. package/force-app/main/default/lwc/quanticPager/e2e/fixture.ts +4 -4
  19. package/force-app/main/default/lwc/quanticPager/e2e/{pagerObject.ts → pageObject.ts} +1 -1
  20. package/force-app/main/default/lwc/quanticTab/__tests__/quanticTab.test.js +287 -0
  21. package/force-app/main/default/lwc/quanticTab/e2e/fixture.ts +62 -0
  22. package/force-app/main/default/lwc/quanticTab/e2e/pageObject.ts +67 -0
  23. package/force-app/main/default/lwc/quanticTab/e2e/quanticTab.e2e.ts +77 -0
  24. package/force-app/main/default/lwc/quanticTab/quanticTab.html +1 -1
  25. package/force-app/main/default/lwc/quanticTabBar/__tests__/quanticTabBar.test.js +331 -0
  26. package/force-app/main/default/lwc/quanticTabBar/e2e/fixture.ts +61 -0
  27. package/force-app/main/default/lwc/quanticTabBar/e2e/pageObject.ts +80 -0
  28. package/force-app/main/default/lwc/quanticTabBar/e2e/quanticTabBar.e2e.ts +173 -0
  29. package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.html +30 -8
  30. package/force-app/main/default/lwc/quanticTabBar/quanticTabBar.js +5 -4
  31. package/force-app/main/default/lwc/quanticUserActionsToggle/e2e/pageObject.ts +1 -1
  32. package/force-app/main/default/lwc/quanticUserActionsToggle/quanticUserActionsToggle.js +4 -0
  33. package/force-app/main/default/lwc/quanticUtils/__tests__/markdownUtils.test.js +1 -1
  34. package/force-app/main/default/staticresources/coveobueno/browser/bueno.js +4 -4
  35. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -10
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/instant-result-analytics.d.ts +1 -1
  37. package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts +1 -1
  38. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +1 -1
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +4 -2
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts +1 -1
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/case-assist-params.d.ts +1 -1
  42. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/insight-params.d.ts +2 -2
  43. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-engine/commerce-engine.ssr.d.ts +2 -0
  44. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/build-factory.d.ts +2 -0
  45. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/factories/utils/recommendation-filter.d.ts +11 -0
  46. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/common.d.ts +12 -2
  47. package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/kind.d.ts +9 -0
  48. package/force-app/main/default/staticresources/coveoheadless/definitions/app/undoable.d.ts +0 -3
  49. package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts +1 -1
  50. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.d.ts +1 -0
  51. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.d.ts +3 -0
  52. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts +7 -6
  53. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.d.ts +3 -1
  54. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.d.ts +1 -2
  55. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.ssr.d.ts +2 -1
  56. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/url-manager/headless-core-url-manager.d.ts +11 -2
  57. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-list/headless-product-list.ssr.d.ts +1 -1
  58. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-view/headless-product-view.ssr.d.ts +1 -0
  59. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/recommendations/headless-recommendations.d.ts +1 -0
  60. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/context/example-deleteme-headless-case-context.d.ts +1 -1
  61. package/force-app/main/default/staticresources/coveoheadless/definitions/features/actions-history/ipx-actions-history-actions.d.ts +1 -1
  62. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +3 -3
  63. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-actions.d.ts +22 -6
  64. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-schema.d.ts +4 -0
  65. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-selectors.d.ts +0 -11
  66. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.d.ts +8 -2
  67. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-serializer.ssr.d.ts +44 -0
  68. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-slice.d.ts +4 -0
  69. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/parameters/parameters-state.d.ts +4 -0
  70. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts +1 -0
  71. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-state.d.ts +1 -0
  72. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-selectors.d.ts +0 -12
  73. package/force-app/main/default/staticresources/coveoheadless/definitions/features/debug/debug-selectors.d.ts +1 -1
  74. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-actions.d.ts +1 -1
  75. package/force-app/main/default/staticresources/coveoheadless/definitions/features/history/history-actions.d.ts +3 -3
  76. package/force-app/main/default/staticresources/coveoheadless/definitions/features/pipeline/select-pipeline.d.ts +1 -1
  77. package/force-app/main/default/staticresources/coveoheadless/definitions/features/query/query-selectors.d.ts +1 -1
  78. package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-document-id.d.ts +1 -1
  79. package/force-app/main/default/staticresources/coveoheadless/definitions/features/question-answering/question-answering-selectors.d.ts +1 -1
  80. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-actions.d.ts +42 -42
  81. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +44 -44
  82. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-actions.d.ts +42 -43
  83. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-mappings.d.ts +1 -1
  84. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +44 -44
  85. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-selectors.d.ts +1 -1
  86. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-hub/search-hub-selectors.d.ts +1 -1
  87. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search-parameters/search-parameter-serializer.d.ts +5 -2
  88. package/force-app/main/default/staticresources/coveoheadless/definitions/selectors/commerce-selectors.index.d.ts +2 -2
  89. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts +4 -3
  90. package/force-app/main/default/staticresources/coveoheadless/definitions/state/commerce-app-state.d.ts +2 -2
  91. package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +4 -0
  92. package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-request.d.ts +44 -44
  93. package/force-app/main/default/staticresources/coveoheadless/definitions/tsdoc-metadata.json +1 -1
  94. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/compare-utils.d.ts +2 -1
  95. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/errors.d.ts +3 -0
  96. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/utils.d.ts +0 -1
  97. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/validate-payload.d.ts +1 -1
  98. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -12
  99. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -11
  100. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +8 -10
  101. package/force-app/main/default/staticresources/dompurify/purify.min.js +2 -1339
  102. package/force-app/main/default/staticresources/marked/marked.min.js +3 -3
  103. package/package.json +12 -16
@@ -10,7 +10,7 @@ export type GeneratedAnswerFeedback = {
10
10
  details?: string;
11
11
  documentUrl?: string;
12
12
  };
13
- export declare const parseEvaluationDetails: (detail: 'yes' | 'no' | 'unknown') => boolean | undefined;
13
+ export declare const parseEvaluationDetails: (detail: "yes" | "no" | "unknown") => boolean | undefined;
14
14
  export declare const logRetryGeneratedAnswer: () => LegacySearchAction;
15
15
  export declare const logOpenGeneratedAnswerSource: (citationId: string) => CustomAction;
16
16
  export declare const logHoverCitation: (citationId: string, citationHoverTimeInMs: number) => CustomAction;
@@ -4,7 +4,7 @@ export declare const redo: import("@reduxjs/toolkit").ActionCreatorWithoutPayloa
4
4
  export declare const snapshot: import("@reduxjs/toolkit").ActionCreatorWithPayload<HistoryState, string>;
5
5
  export declare const back: import("@reduxjs/toolkit").AsyncThunk<void, void, {
6
6
  state?: unknown;
7
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
7
+ dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
8
8
  extra?: unknown;
9
9
  rejectValue?: unknown;
10
10
  serializedErrorType?: unknown;
@@ -14,7 +14,7 @@ export declare const back: import("@reduxjs/toolkit").AsyncThunk<void, void, {
14
14
  }>;
15
15
  export declare const forward: import("@reduxjs/toolkit").AsyncThunk<void, void, {
16
16
  state?: unknown;
17
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
17
+ dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
18
18
  extra?: unknown;
19
19
  rejectValue?: unknown;
20
20
  serializedErrorType?: unknown;
@@ -24,7 +24,7 @@ export declare const forward: import("@reduxjs/toolkit").AsyncThunk<void, void,
24
24
  }>;
25
25
  export declare const change: import("@reduxjs/toolkit").AsyncThunk<HistoryState | undefined, void, {
26
26
  state?: unknown;
27
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
27
+ dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
28
28
  extra?: unknown;
29
29
  rejectValue?: unknown;
30
30
  serializedErrorType?: unknown;
@@ -1,5 +1,5 @@
1
1
  export declare const selectPipeline: ((state: {
2
- pipeline?: string | undefined;
2
+ pipeline?: string;
3
3
  }) => string | undefined) & {
4
4
  clearCache: () => void;
5
5
  resultsCount: () => number;
@@ -1,6 +1,6 @@
1
1
  import { QueryState } from './query-state.js';
2
2
  export declare const selectQuery: ((state: {
3
- query?: QueryState | undefined;
3
+ query?: QueryState;
4
4
  }) => QueryState | undefined) & {
5
5
  clearCache: () => void;
6
6
  resultsCount: () => number;
@@ -10,5 +10,5 @@ export declare const uniqueIdentifierPayloadDefinition: () => RecordValue;
10
10
  export declare const inlineLinkPayloadDefinition: () => RecordValue;
11
11
  export declare function validateQuestionAnsweringActionCreatorPayload(payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload): {
12
12
  payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload;
13
- error?: import("@reduxjs/toolkit").SerializedError | undefined;
13
+ error?: import("@reduxjs/toolkit").SerializedError;
14
14
  };
@@ -1,4 +1,4 @@
1
1
  import { QuestionAnswerDocumentIdentifier } from '../../api/search/search/question-answering.js';
2
2
  import { QuestionAnsweringSection, SearchSection } from '../../state/state-sections.js';
3
- export declare function answerSourceSelector(state: Partial<SearchSection & QuestionAnsweringSection>, documentIdentifier?: QuestionAnswerDocumentIdentifier): import("../../case-assist.index.js").Result | undefined;
3
+ export declare function answerSourceSelector(state: Partial<SearchSection & QuestionAnsweringSection>, documentIdentifier?: QuestionAnswerDocumentIdentifier): import("../../ssr.index.js").Result | undefined;
4
4
  export declare function relatedQuestionSelector(state: Partial<SearchSection & QuestionAnsweringSection>, questionAnswerId: string): import("../../api/search/search/question-answering.js").QuestionAnswer | null;
@@ -90,63 +90,63 @@ export declare const fetchInstantResults: import("@reduxjs/toolkit").AsyncThunk<
90
90
  export declare const buildInstantResultSearchRequest: (state: StateNeededByExecuteSearch, q: string, numberOfResults: number) => Promise<MappedSearchRequest<{
91
91
  numberOfResults: number;
92
92
  q: string;
93
- enableDidYouMean?: boolean | undefined;
93
+ enableDidYouMean?: boolean;
94
94
  url: string;
95
95
  accessToken: string;
96
96
  organizationId: string;
97
- aq?: string | undefined;
98
- cq?: string | undefined;
99
- lq?: string | undefined;
100
- dq?: string | undefined;
101
- firstResult?: number | undefined;
102
- sortCriteria?: string | undefined;
103
- facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
104
- context?: Record<string, string | string[]> | undefined;
105
- dictionaryFieldContext?: Record<string, string> | undefined;
97
+ aq?: string;
98
+ cq?: string;
99
+ lq?: string;
100
+ dq?: string;
101
+ firstResult?: number;
102
+ sortCriteria?: string;
103
+ facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
104
+ context?: Record<string, string | string[]>;
105
+ dictionaryFieldContext?: Record<string, string>;
106
106
  queryCorrection?: {
107
- enabled?: boolean | undefined;
107
+ enabled?: boolean;
108
108
  options?: {
109
- automaticallyCorrect?: "never" | "whenNoResults" | undefined;
110
- } | undefined;
111
- } | undefined;
112
- enableQuerySyntax?: boolean | undefined;
113
- fieldsToInclude?: string[] | undefined;
114
- pipeline?: string | undefined;
115
- searchHub?: string | undefined;
116
- facetOptions?: import("../../facet-options/facet-options.js").FacetOptions | undefined;
117
- debug?: boolean | undefined;
118
- locale?: string | undefined;
119
- filterField?: string | undefined;
120
- parentField?: string | undefined;
121
- childField?: string | undefined;
122
- filterFieldRange?: number | undefined;
109
+ automaticallyCorrect?: "never" | "whenNoResults";
110
+ };
111
+ };
112
+ enableQuerySyntax?: boolean;
113
+ fieldsToInclude?: string[];
114
+ pipeline?: string;
115
+ searchHub?: string;
116
+ facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
117
+ debug?: boolean;
118
+ locale?: string;
119
+ filterField?: string;
120
+ parentField?: string;
121
+ childField?: string;
122
+ filterFieldRange?: number;
123
123
  tab: string;
124
124
  referrer: string | null;
125
125
  timezone: string;
126
126
  analytics?: {
127
- actionCause?: string | undefined;
128
- customData?: object | undefined;
127
+ actionCause?: string;
128
+ customData?: object;
129
129
  clientId: string;
130
- deviceId?: string | undefined;
131
- pageId?: string | undefined;
130
+ deviceId?: string;
131
+ pageId?: string;
132
132
  clientTimestamp: string;
133
133
  documentReferrer: string | null;
134
134
  originContext: string;
135
- userDisplayName?: string | undefined;
136
- documentLocation?: string | null | undefined;
137
- trackingId?: string | undefined;
138
- capture?: boolean | undefined;
139
- source?: string[] | undefined;
140
- } | undefined;
141
- excerptLength?: number | undefined;
142
- actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[] | undefined;
143
- authentication?: string | undefined;
135
+ userDisplayName?: string;
136
+ documentLocation?: string | null;
137
+ trackingId?: string;
138
+ capture?: boolean;
139
+ source?: string[];
140
+ };
141
+ excerptLength?: number;
142
+ actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
143
+ authentication?: string;
144
144
  generateAutomaticFacets?: {
145
145
  desiredCount: number;
146
- numberOfValues?: number | undefined;
147
- currentFacets?: import("../../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[] | undefined;
148
- } | undefined;
149
- pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters | undefined;
146
+ numberOfValues?: number;
147
+ currentFacets?: import("../../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[];
148
+ };
149
+ pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters;
150
150
  }>>;
151
151
  export declare function legacyFetchInstantResults(payload: FetchInstantResultsActionCreatorPayload, config: any): Promise<any>;
152
152
  export declare function legacyFetchPage(state: StateNeededByExecuteSearch, config: any, //eslint-disable-line @typescript-eslint/no-explicit-any
@@ -4,64 +4,64 @@ import { ConfigurationSection } from '../../../state/state-sections.js';
4
4
  import { AutomaticFacetRequest } from '../../facets/automatic-facet-set/interfaces/request.js';
5
5
  type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
6
6
  export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eventDescription?: EventDescription) => Promise<import("../search-mappings.js").MappedSearchRequest<{
7
- pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters | undefined;
7
+ pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters;
8
8
  generateAutomaticFacets?: {
9
9
  desiredCount: number;
10
- numberOfValues?: number | undefined;
11
- currentFacets?: AutomaticFacetRequest[] | undefined;
12
- } | undefined;
13
- filterField?: string | undefined;
14
- childField?: string | undefined;
15
- parentField?: string | undefined;
16
- filterFieldRange?: number | undefined;
17
- facetOptions?: import("../../facet-options/facet-options.js").FacetOptions | undefined;
18
- numberOfResults?: number | undefined;
19
- firstResult?: number | undefined;
20
- facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
21
- cq?: string | undefined;
10
+ numberOfValues?: number;
11
+ currentFacets?: AutomaticFacetRequest[];
12
+ };
13
+ filterField?: string;
14
+ childField?: string;
15
+ parentField?: string;
16
+ filterFieldRange?: number;
17
+ facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
18
+ numberOfResults?: number;
19
+ firstResult?: number;
20
+ facets?: import("../../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
21
+ cq?: string;
22
22
  queryCorrection?: {
23
- enabled?: boolean | undefined;
23
+ enabled?: boolean;
24
24
  options?: {
25
- automaticallyCorrect?: "never" | "whenNoResults" | undefined;
26
- } | undefined;
27
- } | undefined;
28
- enableDidYouMean?: boolean | undefined;
25
+ automaticallyCorrect?: "never" | "whenNoResults";
26
+ };
27
+ };
28
+ enableDidYouMean?: boolean;
29
29
  url: string;
30
30
  accessToken: string;
31
31
  organizationId: string;
32
- q?: string | undefined;
33
- aq?: string | undefined;
34
- lq?: string | undefined;
35
- dq?: string | undefined;
36
- sortCriteria?: string | undefined;
37
- context?: Record<string, string | string[]> | undefined;
38
- dictionaryFieldContext?: Record<string, string> | undefined;
39
- enableQuerySyntax?: boolean | undefined;
40
- fieldsToInclude?: string[] | undefined;
41
- pipeline?: string | undefined;
42
- searchHub?: string | undefined;
43
- debug?: boolean | undefined;
44
- locale?: string | undefined;
32
+ q?: string;
33
+ aq?: string;
34
+ lq?: string;
35
+ dq?: string;
36
+ sortCriteria?: string;
37
+ context?: Record<string, string | string[]>;
38
+ dictionaryFieldContext?: Record<string, string>;
39
+ enableQuerySyntax?: boolean;
40
+ fieldsToInclude?: string[];
41
+ pipeline?: string;
42
+ searchHub?: string;
43
+ debug?: boolean;
44
+ locale?: string;
45
45
  tab: string;
46
46
  referrer: string | null;
47
47
  timezone: string;
48
48
  analytics?: {
49
- actionCause?: string | undefined;
50
- customData?: object | undefined;
49
+ actionCause?: string;
50
+ customData?: object;
51
51
  clientId: string;
52
- deviceId?: string | undefined;
53
- pageId?: string | undefined;
52
+ deviceId?: string;
53
+ pageId?: string;
54
54
  clientTimestamp: string;
55
55
  documentReferrer: string | null;
56
56
  originContext: string;
57
- userDisplayName?: string | undefined;
58
- documentLocation?: string | null | undefined;
59
- trackingId?: string | undefined;
60
- capture?: boolean | undefined;
61
- source?: string[] | undefined;
62
- } | undefined;
63
- excerptLength?: number | undefined;
64
- actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[] | undefined;
65
- authentication?: string | undefined;
57
+ userDisplayName?: string;
58
+ documentLocation?: string | null;
59
+ trackingId?: string;
60
+ capture?: boolean;
61
+ source?: string[];
62
+ };
63
+ excerptLength?: number;
64
+ actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
65
+ authentication?: string;
66
66
  }>>;
67
67
  export {};
@@ -97,62 +97,61 @@ export declare const fetchInstantResults: import("@reduxjs/toolkit").AsyncThunk<
97
97
  export declare const buildInstantResultSearchRequest: (state: StateNeededByExecuteSearch, navigatorContext: NavigatorContext, q: string, numberOfResults: number, eventDescription: EventDescription) => Promise<MappedSearchRequest<{
98
98
  numberOfResults: number;
99
99
  q: string;
100
- enableDidYouMean?: boolean | undefined;
100
+ enableDidYouMean?: boolean;
101
101
  url: string;
102
102
  accessToken: string;
103
103
  organizationId: string;
104
- aq?: string | undefined;
105
- cq?: string | undefined;
106
- lq?: string | undefined;
107
- dq?: string | undefined;
108
- firstResult?: number | undefined;
109
- sortCriteria?: string | undefined;
110
- facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
111
- context?: Record<string, string | string[]> | undefined;
112
- dictionaryFieldContext?: Record<string, string> | undefined;
104
+ aq?: string;
105
+ cq?: string;
106
+ lq?: string;
107
+ dq?: string;
108
+ firstResult?: number;
109
+ sortCriteria?: string;
110
+ facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
111
+ context?: Record<string, string | string[]>;
112
+ dictionaryFieldContext?: Record<string, string>;
113
113
  queryCorrection?: {
114
- enabled?: boolean | undefined;
114
+ enabled?: boolean;
115
115
  options?: {
116
- automaticallyCorrect?: "never" | "whenNoResults" | undefined;
117
- } | undefined;
118
- } | undefined;
119
- enableQuerySyntax?: boolean | undefined;
120
- fieldsToInclude?: string[] | undefined;
121
- pipeline?: string | undefined;
122
- searchHub?: string | undefined;
123
- facetOptions?: import("../facet-options/facet-options.js").FacetOptions | undefined;
124
- debug?: boolean | undefined;
125
- locale?: string | undefined;
126
- filterField?: string | undefined;
127
- parentField?: string | undefined;
128
- childField?: string | undefined;
129
- filterFieldRange?: number | undefined;
116
+ automaticallyCorrect?: "never" | "whenNoResults";
117
+ };
118
+ };
119
+ enableQuerySyntax?: boolean;
120
+ fieldsToInclude?: string[];
121
+ pipeline?: string;
122
+ searchHub?: string;
123
+ facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
124
+ debug?: boolean;
125
+ locale?: string;
126
+ filterField?: string;
127
+ parentField?: string;
128
+ childField?: string;
129
+ filterFieldRange?: number;
130
130
  tab: string;
131
131
  referrer: string | null;
132
- /** The query that was executed. */
133
132
  timezone: string;
134
133
  analytics?: {
135
- actionCause?: string | undefined;
136
- customData?: object | undefined;
134
+ actionCause?: string;
135
+ customData?: object;
137
136
  clientId: string;
138
- deviceId?: string | undefined;
139
- pageId?: string | undefined;
137
+ deviceId?: string;
138
+ pageId?: string;
140
139
  clientTimestamp: string;
141
140
  documentReferrer: string | null;
142
141
  originContext: string;
143
- userDisplayName?: string | undefined;
144
- documentLocation?: string | null | undefined;
145
- trackingId?: string | undefined;
146
- capture?: boolean | undefined;
147
- source?: string[] | undefined;
148
- } | undefined;
149
- excerptLength?: number | undefined;
150
- actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[] | undefined;
151
- authentication?: string | undefined;
142
+ userDisplayName?: string;
143
+ documentLocation?: string | null;
144
+ trackingId?: string;
145
+ capture?: boolean;
146
+ source?: string[];
147
+ };
148
+ excerptLength?: number;
149
+ actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
150
+ authentication?: string;
152
151
  generateAutomaticFacets?: {
153
152
  desiredCount: number;
154
- numberOfValues?: number | undefined;
155
- currentFacets?: import("../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[] | undefined;
156
- } | undefined;
157
- pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters | undefined;
153
+ numberOfValues?: number;
154
+ currentFacets?: import("../facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[];
155
+ };
156
+ pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters;
158
157
  }>>;
@@ -13,7 +13,7 @@ export declare function mapFacetRequest(facetRequest: AnyFacetRequest, mappings:
13
13
  start: string;
14
14
  end: string;
15
15
  endInclusive: boolean;
16
- state: import("../static-filter-set/static-filter-set-state.js").StaticFilterValueState;
16
+ state: import("../../ssr.index.js").FacetValueState;
17
17
  }[];
18
18
  sortCriteria: import("../../ssr.index.js").RangeFacetSortCriterion;
19
19
  rangeAlgorithm: import("../../ssr.index.js").RangeFacetRangeAlgorithm;
@@ -5,64 +5,64 @@ import { ConfigurationSection } from '../../state/state-sections.js';
5
5
  import { AutomaticFacetRequest } from '../facets/automatic-facet-set/interfaces/request.js';
6
6
  type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
7
7
  export declare const buildSearchRequest: (state: StateNeededBySearchRequest, navigatorContext: NavigatorContext, eventDescription?: EventDescription) => Promise<import("./search-mappings.js").MappedSearchRequest<{
8
- pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters | undefined;
8
+ pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters;
9
9
  generateAutomaticFacets?: {
10
10
  desiredCount: number;
11
- numberOfValues?: number | undefined;
12
- currentFacets?: AutomaticFacetRequest[] | undefined;
13
- } | undefined;
14
- filterField?: string | undefined;
15
- childField?: string | undefined;
16
- parentField?: string | undefined;
17
- filterFieldRange?: number | undefined;
18
- facetOptions?: import("../facet-options/facet-options.js").FacetOptions | undefined;
19
- numberOfResults?: number | undefined;
20
- firstResult?: number | undefined;
21
- facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
22
- cq?: string | undefined;
11
+ numberOfValues?: number;
12
+ currentFacets?: AutomaticFacetRequest[];
13
+ };
14
+ filterField?: string;
15
+ childField?: string;
16
+ parentField?: string;
17
+ filterFieldRange?: number;
18
+ facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
19
+ numberOfResults?: number;
20
+ firstResult?: number;
21
+ facets?: import("../facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
22
+ cq?: string;
23
23
  queryCorrection?: {
24
- enabled?: boolean | undefined;
24
+ enabled?: boolean;
25
25
  options?: {
26
- automaticallyCorrect?: "never" | "whenNoResults" | undefined;
27
- } | undefined;
28
- } | undefined;
29
- enableDidYouMean?: boolean | undefined;
26
+ automaticallyCorrect?: "never" | "whenNoResults";
27
+ };
28
+ };
29
+ enableDidYouMean?: boolean;
30
30
  url: string;
31
31
  accessToken: string;
32
32
  organizationId: string;
33
- q?: string | undefined;
34
- aq?: string | undefined;
35
- lq?: string | undefined;
36
- dq?: string | undefined;
37
- sortCriteria?: string | undefined;
38
- context?: Record<string, string | string[]> | undefined;
39
- dictionaryFieldContext?: Record<string, string> | undefined;
40
- enableQuerySyntax?: boolean | undefined;
41
- fieldsToInclude?: string[] | undefined;
42
- pipeline?: string | undefined;
43
- searchHub?: string | undefined;
44
- debug?: boolean | undefined;
45
- locale?: string | undefined;
33
+ q?: string;
34
+ aq?: string;
35
+ lq?: string;
36
+ dq?: string;
37
+ sortCriteria?: string;
38
+ context?: Record<string, string | string[]>;
39
+ dictionaryFieldContext?: Record<string, string>;
40
+ enableQuerySyntax?: boolean;
41
+ fieldsToInclude?: string[];
42
+ pipeline?: string;
43
+ searchHub?: string;
44
+ debug?: boolean;
45
+ locale?: string;
46
46
  tab: string;
47
47
  referrer: string | null;
48
48
  timezone: string;
49
49
  analytics?: {
50
- actionCause?: string | undefined;
51
- customData?: object | undefined;
50
+ actionCause?: string;
51
+ customData?: object;
52
52
  clientId: string;
53
- deviceId?: string | undefined;
54
- pageId?: string | undefined;
53
+ deviceId?: string;
54
+ pageId?: string;
55
55
  clientTimestamp: string;
56
56
  documentReferrer: string | null;
57
57
  originContext: string;
58
- userDisplayName?: string | undefined;
59
- documentLocation?: string | null | undefined;
60
- trackingId?: string | undefined;
61
- capture?: boolean | undefined;
62
- source?: string[] | undefined;
63
- } | undefined;
64
- excerptLength?: number | undefined;
65
- actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[] | undefined;
66
- authentication?: string | undefined;
58
+ userDisplayName?: string;
59
+ documentLocation?: string | null;
60
+ trackingId?: string;
61
+ capture?: boolean;
62
+ source?: string[];
63
+ };
64
+ excerptLength?: number;
65
+ actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
66
+ authentication?: string;
67
67
  }>>;
68
68
  export {};
@@ -1,3 +1,3 @@
1
1
  import { SearchSection } from '../../state/state-sections.js';
2
2
  export declare function firstSearchExecutedSelector(state: SearchSection): boolean;
3
- export declare function resultFromFieldSelector(state: SearchSection, contentIdKey: string, contentIdValue: string): import("../../case-assist.index.js").Result | undefined;
3
+ export declare function resultFromFieldSelector(state: SearchSection, contentIdKey: string, contentIdValue: string): import("../../ssr.index.js").Result | undefined;
@@ -1,5 +1,5 @@
1
1
  export declare const selectSearchHub: ((state: {
2
- searchHub?: string | undefined;
2
+ searchHub?: string;
3
3
  }) => string | undefined) & {
4
4
  clearCache: () => void;
5
5
  resultsCount: () => number;
@@ -1,3 +1,5 @@
1
+ import { DateRangeRequest } from '../../controllers/facets/range-facet/date-facet/headless-date-facet.js';
2
+ import { FacetValueState } from '../../ssr.index.js';
1
3
  import { RangeValueRequest } from '../facets/range-facets/generic/interfaces/range-facet.js';
2
4
  import { SearchParameters } from './search-parameter-actions.js';
3
5
  export declare const rangeDelimiterExclusive = "..";
@@ -26,13 +28,14 @@ export declare function serializeSpecialCharacters(key: string, val: unknown): s
26
28
  export declare function isFacetObject(obj: unknown): obj is Record<string, string[]>;
27
29
  export declare function isRangeFacetObject(obj: unknown): obj is Record<string, RangeValueRequest[]>;
28
30
  export declare function isObject(obj: unknown): obj is object;
31
+ export declare function allEntriesAreValid(obj: object, isValidValue: (v: unknown) => boolean): boolean;
29
32
  export declare function serializeFacets(key: string, facets: Record<string, string[]>): string;
30
33
  export declare function serializeRangeFacets(key: string, facets: Record<string, RangeValueRequest[]>): string;
31
34
  declare function deserialize(fragment: string): SearchParameters;
32
35
  export declare function splitOnFirstEqual(str: string): string[];
33
36
  export declare function preprocessObjectPairs(pair: string[], regex?: RegExp): string[];
34
- export declare function buildNumericRanges(ranges: string[]): import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericRangeRequest[];
35
- export declare function buildDateRanges(ranges: string[]): import("../facets/range-facets/date-facet-set/interfaces/request.js").DateRangeRequest[];
37
+ export declare function buildNumericRanges(ranges: string[], state: FacetValueState): import("../../ssr.index.js").NumericRangeRequest[];
38
+ export declare function buildDateRanges(ranges: string[], state: FacetValueState): DateRangeRequest[];
36
39
  export declare function cast<K extends SearchParameterKey>(pair: [K, string], decode?: boolean): [K, unknown];
37
40
  export declare function castUnknownObject(value: string): UnknownObject;
38
41
  export {};
@@ -1,7 +1,7 @@
1
1
  import { CommerceEngine } from '../app/commerce-engine/commerce-engine.js';
2
2
  export declare namespace Search {
3
- const responseIdSelector: (engine: CommerceEngine<{}>) => string;
3
+ const responseIdSelector: (engine: CommerceEngine) => string;
4
4
  }
5
5
  export declare namespace ProductListing {
6
- const responseIdSelector: (engine: CommerceEngine<{}>) => string;
6
+ const responseIdSelector: (engine: CommerceEngine) => string;
7
7
  }
@@ -77,7 +77,8 @@ export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/comm
77
77
  export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
78
78
  export type { EngineConfiguration, AnalyticsConfiguration, AnalyticsRuntimeEnvironment, } from './app/engine-configuration.js';
79
79
  export { SolutionType } from './app/commerce-ssr-engine/types/common.js';
80
- export type { ControllerDefinitionsMap, InferControllerFromDefinition, InferControllersMapFromDefinition, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllerPropsMapFromDefinitions, EngineStaticState, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple, } from './app/commerce-ssr-engine/types/common.js';
80
+ export type { ControllerDefinition, ControllerDefinitionsMap, InferControllerFromDefinition, InferControllersMapFromDefinition, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllerPropsMapFromDefinitions, EngineStaticState, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple, ControllerWithKind, } from './app/commerce-ssr-engine/types/common.js';
81
+ export { Kind } from './app/commerce-ssr-engine/types/kind.js';
81
82
  export type { EngineDefinition, InferStaticState, InferHydratedState, InferBuildResult, HydrateStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticStateOptions, Build, BuildOptions, FromBuildResult, FromBuildResultOptions, } from './app/commerce-ssr-engine/types/core-engine.js';
82
83
  export type { LoggerOptions } from './app/logger.js';
83
84
  export type { NavigatorContext, BrowserNavigatorContextProvider, NavigatorContextProvider, } from './app/navigatorContextProvider.js';
@@ -90,7 +91,7 @@ export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, Category
90
91
  export { defineFacetGenerator } from './controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.js';
91
92
  export type { Pagination, PaginationProps, PaginationState, } from './controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.js';
92
93
  export { definePagination } from './controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.js';
93
- export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.js';
94
+ export type { ParameterManager, ParameterManagerProps, SSRParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.js';
94
95
  export { defineParameterManager } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.js';
95
96
  export type { ProductList, ProductListState, } from './controllers/commerce/product-list/headless-product-list.ssr.js';
96
97
  export { defineProductList } from './controllers/commerce/product-list/headless-product-list.ssr.js';
@@ -158,7 +159,7 @@ export type { Template } from './features/templates/templates-manager.js';
158
159
  export type { ProductTemplate, ProductTemplateCondition, ProductTemplatesManager, } from './features/commerce/product-templates/product-templates-manager.js';
159
160
  export { ProductTemplatesHelpers } from './features/commerce/product-templates/product-templates-helpers.js';
160
161
  export type { PlatformEnvironment } from './utils/url-utils.js';
161
- export { buildSearchParameterSerializer } from './features/search-parameters/search-parameter-serializer.js';
162
+ export { buildParameterSerializer } from './features/commerce/parameters/parameters-serializer.ssr.js';
162
163
  export type { HighlightKeyword } from './utils/highlight.js';
163
164
  export { VERSION } from './utils/version.js';
164
165
  export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
@@ -1,4 +1,4 @@
1
- import { CommercePaginationSection, CartSection, CommerceContextSection, ProductListingSection, RecommendationsSection, VersionSection, CommerceSortSection, CommerceSearchSection, CommerceQuerySection, CommerceFacetSetSection, FacetOrderSection, QuerySuggestionSection, QuerySetSection, FacetSearchSection, CategoryFacetSearchSection, CommerceDidYouMeanSection, InstantProductsSection, CommerceStandaloneSearchBoxSection, RecentQueriesSection, FieldSuggestionsOrderSection, TriggerSection, ManualRangeSection, CommerceConfigurationSection } from './state-sections.js';
1
+ import { CommercePaginationSection, CartSection, CommerceContextSection, ProductListingSection, RecommendationsSection, VersionSection, CommerceSortSection, CommerceSearchSection, CommerceQuerySection, CommerceFacetSetSection, FacetOrderSection, QuerySuggestionSection, QuerySetSection, FacetSearchSection, CategoryFacetSearchSection, CommerceDidYouMeanSection, InstantProductsSection, CommerceStandaloneSearchBoxSection, RecentQueriesSection, FieldSuggestionsOrderSection, TriggerSection, ManualRangeSection, CommerceConfigurationSection, CommerceParametersSection } from './state-sections.js';
2
2
  export type CommerceProductListingParametersState = CommerceFacetSetSection & CommerceSortSection & CommercePaginationSection;
3
3
  export type CommerceSearchParametersState = CommerceProductListingParametersState & CommerceQuerySection;
4
- export type CommerceAppState = CommerceConfigurationSection & CommerceStandaloneSearchBoxSection & ProductListingSection & RecommendationsSection & CommerceSearchSection & CommerceQuerySection & FacetOrderSection & FacetSearchSection & CategoryFacetSearchSection & CommerceFacetSetSection & CommercePaginationSection & CommerceSortSection & CommerceContextSection & CartSection & RecentQueriesSection & QuerySuggestionSection & QuerySetSection & CommerceDidYouMeanSection & InstantProductsSection & FieldSuggestionsOrderSection & TriggerSection & ManualRangeSection & VersionSection;
4
+ export type CommerceAppState = CommerceConfigurationSection & CommerceStandaloneSearchBoxSection & ProductListingSection & RecommendationsSection & CommerceSearchSection & CommerceQuerySection & FacetOrderSection & FacetSearchSection & CategoryFacetSearchSection & CommerceFacetSetSection & CommercePaginationSection & CommerceSortSection & CommerceContextSection & CommerceParametersSection & CartSection & RecentQueriesSection & QuerySuggestionSection & QuerySetSection & CommerceDidYouMeanSection & InstantProductsSection & FieldSuggestionsOrderSection & TriggerSection & ManualRangeSection & VersionSection;
@@ -14,6 +14,7 @@ import { FieldSuggestionsOrderState } from '../features/commerce/facets/field-su
14
14
  import { ManualNumericFacetSetState } from '../features/commerce/facets/numeric-facet/manual-numeric-facet-state.js';
15
15
  import { InstantProductsState } from '../features/commerce/instant-products/instant-products-state.js';
16
16
  import { CommercePaginationState } from '../features/commerce/pagination/pagination-state.js';
17
+ import { CommerceParametersState } from '../features/commerce/parameters/parameters-state.js';
17
18
  import { ProductListingState } from '../features/commerce/product-listing/product-listing-state.js';
18
19
  import { CommerceQueryState } from '../features/commerce/query/query-state.js';
19
20
  import { RecommendationsState as CommerceRecommendationsState } from '../features/commerce/recommendations/recommendations-state.js';
@@ -71,6 +72,9 @@ export interface AdvancedSearchQueriesSection {
71
72
  */
72
73
  advancedSearchQueries: AdvancedSearchQueriesState;
73
74
  }
75
+ export interface CommerceParametersSection {
76
+ commerceParameters: CommerceParametersState;
77
+ }
74
78
  export interface StaticFilterSection {
75
79
  /**
76
80
  * The set of static filters.