@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
@@ -3,60 +3,60 @@ export declare function buildMockSearchRequest(config?: Partial<SearchRequest>):
3
3
  url: string;
4
4
  accessToken: string;
5
5
  organizationId: string;
6
- q?: string | undefined;
7
- aq?: string | undefined;
8
- cq?: string | undefined;
9
- lq?: string | undefined;
10
- dq?: string | undefined;
11
- numberOfResults?: number | undefined;
12
- firstResult?: number | undefined;
13
- sortCriteria?: string | undefined;
14
- facets?: import("../features/facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[] | undefined;
15
- context?: Record<string, string | string[]> | undefined;
16
- dictionaryFieldContext?: Record<string, string> | undefined;
17
- enableDidYouMean?: boolean | undefined;
6
+ q?: string;
7
+ aq?: string;
8
+ cq?: string;
9
+ lq?: string;
10
+ dq?: string;
11
+ numberOfResults?: number;
12
+ firstResult?: number;
13
+ sortCriteria?: string;
14
+ facets?: import("../features/facets/generic/interfaces/generic-facet-request.js").AnyFacetRequest[];
15
+ context?: Record<string, string | string[]>;
16
+ dictionaryFieldContext?: Record<string, string>;
17
+ enableDidYouMean?: boolean;
18
18
  queryCorrection?: {
19
- enabled?: boolean | undefined;
19
+ enabled?: boolean;
20
20
  options?: {
21
- automaticallyCorrect?: "never" | "whenNoResults" | undefined;
22
- } | undefined;
23
- } | undefined;
24
- enableQuerySyntax?: boolean | undefined;
25
- fieldsToInclude?: string[] | undefined;
26
- pipeline?: string | undefined;
27
- searchHub?: string | undefined;
28
- facetOptions?: import("../features/facet-options/facet-options.js").FacetOptions | undefined;
29
- debug?: boolean | undefined;
30
- locale?: string | undefined;
31
- filterField?: string | undefined;
32
- parentField?: string | undefined;
33
- childField?: string | undefined;
34
- filterFieldRange?: number | undefined;
21
+ automaticallyCorrect?: "never" | "whenNoResults";
22
+ };
23
+ };
24
+ enableQuerySyntax?: boolean;
25
+ fieldsToInclude?: string[];
26
+ pipeline?: string;
27
+ searchHub?: string;
28
+ facetOptions?: import("../features/facet-options/facet-options.js").FacetOptions;
29
+ debug?: boolean;
30
+ locale?: string;
31
+ filterField?: string;
32
+ parentField?: string;
33
+ childField?: string;
34
+ filterFieldRange?: number;
35
35
  tab: string;
36
36
  referrer: string | null;
37
37
  timezone: string;
38
38
  analytics?: {
39
- actionCause?: string | undefined;
40
- customData?: object | undefined;
39
+ actionCause?: string;
40
+ customData?: object;
41
41
  clientId: string;
42
- deviceId?: string | undefined;
43
- pageId?: string | undefined;
42
+ deviceId?: string;
43
+ pageId?: string;
44
44
  clientTimestamp: string;
45
45
  documentReferrer: string | null;
46
46
  originContext: string;
47
- userDisplayName?: string | undefined;
48
- documentLocation?: string | null | undefined;
49
- trackingId?: string | undefined;
50
- capture?: boolean | undefined;
51
- source?: string[] | undefined;
52
- } | undefined;
53
- excerptLength?: number | undefined;
54
- actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[] | undefined;
55
- authentication?: string | undefined;
47
+ userDisplayName?: string;
48
+ documentLocation?: string | null;
49
+ trackingId?: string;
50
+ capture?: boolean;
51
+ source?: string[];
52
+ };
53
+ excerptLength?: number;
54
+ actionsHistory?: import("coveo.analytics/dist/definitions/history.js").HistoryElement[];
55
+ authentication?: string;
56
56
  generateAutomaticFacets?: {
57
57
  desiredCount: number;
58
- numberOfValues?: number | undefined;
59
- currentFacets?: import("../features/facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[] | undefined;
60
- } | undefined;
61
- pipelineRuleParameters?: import("../api/search/search-api-params.js").PipelineRuleParameters | undefined;
58
+ numberOfValues?: number;
59
+ currentFacets?: import("../features/facets/automatic-facet-set/interfaces/request.js").AutomaticFacetRequest[];
60
+ };
61
+ pipelineRuleParameters?: import("../api/search/search-api-params.js").PipelineRuleParameters;
62
62
  };
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.47.3"
8
+ "packageVersion": "7.48.1"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,3 +1,4 @@
1
+ import { PrimitivesValues } from '@coveo/bueno';
1
2
  export declare function arrayEqual<T>(firstArray: T[], secondArray: T[], isEqual?: (first: T, second: T) => boolean): boolean;
2
3
  /**
3
4
  * Checks if two arrays of primitive values have the same elements, in different order.
@@ -7,5 +8,5 @@ export declare function arrayEqual<T>(firstArray: T[], secondArray: T[], isEqual
7
8
  * @param secondArray The second array of primitive values to compare.
8
9
  * @returns `true` if the arrays have the same elements in different orders, `false` otherwise. Unless the two arrays have only one identical element each, this function will return `false` if the two arrays have the same elements in the same order.
9
10
  */
10
- export declare const arrayEqualStrictlyDifferentOrder: <T extends string | number | boolean | null | undefined>(firstArray: T[], secondArray: T[]) => boolean;
11
+ export declare const arrayEqualStrictlyDifferentOrder: <T extends Exclude<PrimitivesValues, object>>(firstArray: T[], secondArray: T[]) => boolean;
11
12
  export declare const deepEqualAnyOrder: <T>(a: T, b: T) => boolean;
@@ -5,6 +5,9 @@ export declare class ExpiredTokenError extends Error {
5
5
  export declare class InvalidControllerDefinition extends Error {
6
6
  constructor();
7
7
  }
8
+ export declare class MultipleRecommendationError extends Error {
9
+ constructor(slotId: string);
10
+ }
8
11
  export declare class DisconnectedError extends Error {
9
12
  statusCode: number;
10
13
  constructor(url: string, statusCode?: number);
@@ -1,4 +1,3 @@
1
- /// <reference types="node" resolution-mode="require"/>
2
1
  import { Middleware, Action } from '@reduxjs/toolkit';
3
2
  export declare const randomID: (prepend?: string, length?: number) => string;
4
3
  export declare function isArray<T>(value: T | T[]): value is T[];
@@ -23,7 +23,7 @@ export declare const validatePayloadAndThrow: <P>(payload: P, definition: Schema
23
23
  */
24
24
  export declare const validatePayload: <P>(payload: P, definition: SchemaDefinition<Required<P>> | SchemaValue<P>) => {
25
25
  payload: P;
26
- error?: SerializedError | undefined;
26
+ error?: SerializedError;
27
27
  };
28
28
  export declare const validateInitialState: <T extends object>(engine: CoreEngine | CoreEngineNext, schema: Schema<T>, obj: T | undefined, functionName: string) => Partial<T>;
29
29
  export declare const validateOptions: <T extends object>(engine: CoreEngine<object> | CoreEngineNext<object>, schema: Schema<T>, obj: Partial<T> | undefined, functionName: string) => Partial<Partial<T>>;