@coveo/quantic 3.30.4-pre.fbe332fd49 → 3.30.5-pre.0c1931ccff

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 (40) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts +1 -1
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +7 -6
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +2 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-mocks.d.ts +209 -0
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +6 -78
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +2 -2
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +1 -1
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +1 -1
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/cart/headless-cart.ssr.d.ts +1 -0
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/context/headless-context.ssr.d.ts +1 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +1 -0
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/engine/commerce-engine.ssr.d.ts +5 -1
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/factories/build-factory.d.ts +20 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/controller-definitions.d.ts +9 -0
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/engine.d.ts +2 -0
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts +2 -0
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce.index.d.ts +2 -3
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/cart/headless-cart.ssr.d.ts +2 -0
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/context/headless-context.ssr.d.ts +2 -0
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +2 -0
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +4 -1
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +2 -2
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts +1 -1
  33. package/force-app/main/default/staticresources/coveoheadless/headless.js +9 -9
  34. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +6 -6
  35. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
  36. package/package.json +2 -10
  37. package/scripts/npm/check-sfdx-project.js +1 -1
  38. package/scripts/npm/setup-quantic.js +2 -2
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +0 -8318
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +0 -8
@@ -36,6 +36,8 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
36
36
  */
37
37
  setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
38
38
  /**
39
+ * @deprecated This method is deprecated and will be removed in a future major version. Use the `fetchStaticState` method instead.
40
+ *
39
41
  * Builds an engine and its controllers from an engine definition.
40
42
  */
41
43
  build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
@@ -68,7 +68,6 @@
68
68
  */
69
69
  export type { Relay } from '@coveo/relay';
70
70
  export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
71
- export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
72
71
  export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
73
72
  export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
74
73
  export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
@@ -117,9 +116,9 @@ export type { QueryTrigger, QueryTriggerDefinition, QueryTriggerState, } from '.
117
116
  export { defineQueryTrigger } from './ssr/commerce/controllers/triggers/headless-query-trigger.ssr.js';
118
117
  export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTriggerState, } from './ssr/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
119
118
  export { defineRedirectionTrigger } from './ssr/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
120
- export type { CommerceEngineDefinition } from './ssr/commerce/engine/commerce-engine.ssr.js';
119
+ export type { CommerceEngineDefinition, CommerceEngineOptions, } from './ssr/commerce/engine/commerce-engine.ssr.js';
121
120
  export { defineCommerceEngine } from './ssr/commerce/engine/commerce-engine.ssr.js';
122
- export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr/commerce/factories/build-factory.js';
121
+ export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, SSRCommerceEngineOptions, } from './ssr/commerce/factories/build-factory.js';
123
122
  export { SolutionType } from './ssr/commerce/types/controller-constants.js';
124
123
  export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr/commerce/types/controller-definitions.js';
125
124
  export type { InferBuildResult, InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr/commerce/types/controller-inference.js';
@@ -10,5 +10,7 @@ export type CartDefinition = UniversalControllerDefinitionWithProps<Cart, CartBu
10
10
  * @group Definers
11
11
  *
12
12
  * @returns The `Cart` controller definition.
13
+ *
14
+ * Note: This controller is automatically included in all engine definitions. You do not need to add it manually to your engine definition configuration.
13
15
  */
14
16
  export declare function defineCart(): CartDefinition;
@@ -9,5 +9,7 @@ export type ContextDefinition = UniversalControllerDefinitionWithProps<Context,
9
9
  * @group Definers
10
10
  *
11
11
  * @returns The `Context` controller definition.
12
+ *
13
+ * Note: This controller is automatically included in all engine definitions. You do not need to add it manually to your engine definition configuration.
12
14
  */
13
15
  export declare function defineContext(): ContextDefinition;
@@ -10,6 +10,8 @@ export type ParameterManagerDefinition = SearchAndListingControllerDefinitionWit
10
10
  * @group Definers
11
11
  *
12
12
  * @returns The `ParameterManager` controller definition.
13
+ *
14
+ * Note: This controller is automatically included in all engine definitions. You do not need to add it manually to your engine definition configuration.
13
15
  */
14
16
  export declare function defineParameterManager(): ParameterManagerDefinition;
15
17
  export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
@@ -9,7 +9,10 @@ import type { SolutionType } from './controller-constants.js';
9
9
  import type { ControllerDefinitionsMap, IsRecommendationController } from './controller-definitions.js';
10
10
  export interface SearchBuildConfig extends CommonBuildConfig {
11
11
  searchParams: ParameterManagerState<Parameters & {
12
- query: string;
12
+ /**
13
+ * The query.
14
+ */
15
+ q?: string;
13
16
  }>['parameters'];
14
17
  }
15
18
  export interface ListingBuildConfig extends CommonBuildConfig {
@@ -1,6 +1,5 @@
1
1
  import type { BaseQueryFn, CombinedState, FetchArgs, FetchBaseQueryError, QueryDefinition, RetryOptions } from '@reduxjs/toolkit/query';
2
2
  import type { GeneratedAnswerStream } from '../api/knowledge/generated-answer-stream.js';
3
- import type { SearchRequest } from '../api/search/search/search-request.js';
4
3
  import type { StateWithHistory } from '../app/undoable.js';
5
4
  import type { AdvancedSearchQueriesState } from '../features/advanced-search-queries/advanced-search-queries-state.js';
6
5
  import type { AttachedResultsState } from '../features/attached-results/attached-results-state.js';
@@ -41,6 +40,7 @@ import type { DateFacetSetState } from '../features/facets/range-facets/date-fac
41
40
  import type { NumericFacetSetState } from '../features/facets/range-facets/numeric-facet-set/numeric-facet-set-state.js';
42
41
  import type { FieldsState } from '../features/fields/fields-state.js';
43
42
  import type { FoldingState } from '../features/folding/folding-state.js';
43
+ import type { AnswerApiQueryParams } from '../features/generated-answer/generated-answer-request.js';
44
44
  import type { GeneratedAnswerState } from '../features/generated-answer/generated-answer-state.js';
45
45
  import type { HistoryState } from '../features/history/history-state.js';
46
46
  import type { InsightConfigurationState } from '../features/insight-configuration/insight-configuration-state.js';
@@ -443,6 +443,6 @@ export interface ManualRangeSection {
443
443
  }
444
444
  export interface GetAnswerQuerySection {
445
445
  answer: CombinedState<{
446
- getAnswer: QueryDefinition<Partial<SearchRequest>, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerStream, 'answer'>;
446
+ getAnswer: QueryDefinition<AnswerApiQueryParams, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerStream, 'answer'>;
447
447
  }, never, 'answer'>;
448
448
  }
@@ -9,5 +9,5 @@ export declare function sortFacets<T extends {
9
9
  facetId: string;
10
10
  }>(facets: T[], sortOrder: string[]): T[];
11
11
  export declare const sortCriteriaMap: Record<string, SortCriteria>;
12
- export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[];
12
+ export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
13
13
  export {};