@coveo/quantic 3.28.1 → 3.28.2-pre.04d5730f85

package/force-app/main/default/staticresources/coveoheadless/definitions/app/ssr-engine/types/common.d.ts

@@ -1,80 +0,0 @@
-import type { UnknownAction } from '@reduxjs/toolkit';
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { CoreEngine, CoreEngineNext } from '../../engine.js';
-export type HasKey<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] extends never ? never : true : never : never;
-export type HasKeys<TObject> = TObject extends {} ? keyof TObject extends never ? false : true : boolean;
-export type HasRequiredKeys<TObject> = TObject extends {} ? {
-    [K in keyof TObject]-?: {} extends Pick<TObject, K> ? never : K;
-}[keyof TObject] extends never ? false : true : boolean;
-export type HasOptionalKeys<TObject> = TObject extends {} ? {
-    [K in keyof TObject]-?: {} extends Pick<TObject, K> ? K : never;
-}[keyof TObject] extends never ? false : true : boolean;
-type ExtractRequiredOptions<TOptions> = {
-    [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
-};
-export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
-export type OptionsExtender<TOptions> = (options: TOptions) => TOptions | Promise<TOptions>;
-export interface ControllersPropsMap {
-    [customName: string]: unknown;
-}
-export interface ControllersMap {
-    [customName: string]: Controller;
-}
-interface ControllerStaticState<TState> {
-    state: TState;
-}
-export interface ControllerStaticStateMap {
-    [customName: string]: ControllerStaticState<unknown>;
-}
-export interface ControllerDefinitionWithoutProps<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> {
-    /**
-     * Creates an instance of the given controller.
-     *
-     * @param engine - The search engine.
-     * @returns The controller.
-     */
-    build(engine: TEngine): TController;
-}
-export interface ControllerDefinitionWithProps<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller, TProps> {
-    /**
-     * Creates an instance of the given controller.
-     *
-     * @param engine - The search engine.
-     * @param props - The controller properties.
-     * @returns The controller.
-     */
-    buildWithProps(engine: TEngine, props?: TProps): TController;
-}
-export type ControllerDefinition<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> = ControllerDefinitionWithoutProps<TEngine, TController> | ControllerDefinitionWithProps<TEngine, TController, unknown>;
-export interface ControllerDefinitionsMap<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> {
-    [customName: string]: ControllerDefinition<TEngine, TController>;
-}
-export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
-    engine: TEngine;
-    controllers: TControllers;
-}
-export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
-    searchAction: TSearchAction;
-    controllers: TControllers;
-}
-export interface HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> extends EngineDefinitionBuildResult<TEngine, TControllers> {
-}
-export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TController extends ControllerDefinitionWithProps<CoreEngine | CoreEngineNext, Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<CoreEngine | CoreEngineNext, Controller> ? {} : unknown;
-export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
-    [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
-};
-export type InferControllerFromDefinition<TDefinition extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TDefinition extends ControllerDefinition<infer _, infer TController> ? TController : never;
-export type InferControllersMapFromDefinition<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
-    [K in keyof TControllers]: InferControllerFromDefinition<TControllers[K]>;
-};
-export type InferControllerStaticStateFromController<TController extends Controller> = ControllerStaticState<TController['state']>;
-export type InferControllerStaticStateMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
-    [K in keyof TControllers]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
-};
-export type InferControllerStaticStateMapFromControllers<TControllers extends ControllersMap> = {
-    [K in keyof TControllers]: InferControllerStaticStateFromController<TControllers[K]>;
-};
-export type EngineDefinitionControllersPropsOption<TControllersPropsMap extends ControllersPropsMap> = HasKeys<TControllersPropsMap> extends false ? {} : {
-    controllers: TControllersPropsMap;
-};
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/breadcrumb-manager/headless-breadcrumb-manager.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type BreadcrumbManager } from './headless-breadcrumb-manager.js';
-export * from './headless-breadcrumb-manager.js';
-export interface BreadcrumbManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, BreadcrumbManager> {
-}
-/**
- * Defines a `BreadcrumbManager` controller instance.
- * @group Definers
- *
- * @returns The `BreadcrumbManager` controller definition.
- * */
-export declare function defineBreadcrumbManager(): BreadcrumbManagerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/summary/headless-core-summary.ssr.d.ts

@@ -1,13 +0,0 @@
-import { type ControllerDefinitionOption, type SubControllerDefinitionWithoutProps } from '../../../../app/commerce-ssr-engine/types/common.js';
-import type { ProductListingSummaryState } from '../../product-listing/summary/headless-product-listing-summary.js';
-import type { RecommendationsSummaryState } from '../../recommendations/summary/headless-recommendations-summary.js';
-import type { SearchSummaryState } from '../../search/summary/headless-search-summary.js';
-import type { Summary, SummaryState } from './headless-core-summary.js';
-export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
-/**
- * Defines a `Summary` controller instance.
- * @group Definers
- *
- * @returns The `Summary` controller definition.
- */
-export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts

@@ -1,16 +0,0 @@
-import type { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
-import { type FilterSuggestionsGenerator } from './headless-filter-suggestions-generator.js';
-export type { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
-export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, } from './headless-category-filter-suggestions.js';
-export type { FilterSuggestions, FilterSuggestionsState, } from './headless-filter-suggestions.js';
-export type { GeneratedFilterSuggestionsControllers } from './headless-filter-suggestions-generator.js';
-export type { FilterSuggestionsGenerator };
-export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
-}
-/**
- * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `FilterSuggestionsGenerator` controller definition.
- */
-export declare function defineFilterSuggestionsGenerator(): FilterSuggestionsGeneratorDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/product-list/headless-product-list.ssr.d.ts

@@ -1,13 +0,0 @@
-import { type ControllerDefinitionOption, type SubControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
-import { type ProductListing } from '../product-listing/headless-product-listing.js';
-import { type Search } from '../search/headless-search.js';
-export type { ProductListing, ProductListingState as ProductListState, } from '../product-listing/headless-product-listing.js';
-export type { Search } from '../search/headless-search.js';
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
-/**
- * Defines a `ProductList` controller instance.
- * @group Definers
- *
- * @returns The `ProductList` controller definition.
- */
-export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/context/headless-context.ssr.d.ts

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithProps } from '../../app/ssr-engine/types/common.js';
-import type { ContextProps } from '../core/context/headless-core-context.js';
-import { type Context } from './headless-context.js';
-export * from './headless-context.js';
-export interface ContextDefinition extends ControllerDefinitionWithProps<SearchEngine, Context, ContextProps> {
-}
-/**
- * Defines a `Context` controller instance.
- * @group Definers
- *
- * @returns The `Context` controller definition.
- * */
-export declare function defineContext(): ContextDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/dictionary-field-context/headless-dictionary-field-context.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { CoreEngine } from '../../app/engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type DictionaryFieldContext } from './headless-dictionary-field-context.js';
-export * from './headless-dictionary-field-context.js';
-export interface DictionaryFieldContextDefinition extends ControllerDefinitionWithoutProps<CoreEngine, DictionaryFieldContext> {
-}
-/**
- * Defines a `DictionaryFieldContext` controller instance.
- * @group Definers
- *
- * @returns The `DictionaryFieldContext` controller definition.
- * */
-export declare function defineDictionaryFieldContext(): DictionaryFieldContextDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type DidYouMean } from './headless-did-you-mean.js';
-export * from './headless-did-you-mean.js';
-export interface DidYouMeanDefinition extends ControllerDefinitionWithoutProps<SearchEngine, DidYouMean> {
-}
-/**
- * Defines a `DidYouMean` controller instance.
- * @group Definers
- *
- * @returns The `DidYouMean` controller definition.
- * */
-export declare function defineDidYouMean(): DidYouMeanDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facet-manager/headless-facet-manager.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type FacetManager } from './headless-facet-manager.js';
-export * from './headless-facet-manager.js';
-export interface FacetManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, FacetManager> {
-}
-/**
- * Defines a `FacetManager` controller instance.
- * @group Definers
- *
- * @returns The `FacetManager` controller definition.
- * */
-export declare function defineFacetManager(): FacetManagerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../../../app/ssr-engine/types/common.js';
-import { type DateFacet, type DateFacetProps } from './headless-date-facet.js';
-export * from './headless-date-facet.js';
-export { buildDateRange } from './headless-date-facet.js';
-export interface DateFacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, DateFacet> {
-}
-/**
- * Defines a `DateFacet` controller instance.
- * @group Definers
- *
- * @param props - The configurable `DateFacet` properties.
- * @returns The `DateFacet` controller definition.
- * */
-export declare function defineDateFacet(props: DateFacetProps): DateFacetDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../../../app/ssr-engine/types/common.js';
-import { type NumericFacet, type NumericFacetProps } from './headless-numeric-facet.js';
-export * from './headless-numeric-facet.js';
-export { buildNumericRange } from './headless-numeric-facet.js';
-export interface NumericFacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NumericFacet> {
-}
-/**
- * Defines a `NumericFacet` controller instance.
- * @group Definers
- *
- * @param props - The configurable `NumericFacet` properties.
- * @returns The `NumericFacet` controller definition.
- * */
-export declare function defineNumericFacet(props: NumericFacetProps): NumericFacetDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/history-manager/headless-history-manager.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type HistoryManager } from './headless-history-manager.js';
-export * from './headless-history-manager.js';
-export interface HistoryManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, HistoryManager> {
-}
-/**
- * Defines a `HistoryManager` controller instance.
- * @group Definers
- *
- * @returns The `HistoryManager` controller definition.
- * */
-export declare function defineHistoryManager(): HistoryManagerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-error/headless-query-error.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type QueryError } from './headless-query-error.js';
-export * from './headless-query-error.js';
-export interface QueryErrorDefinition extends ControllerDefinitionWithoutProps<SearchEngine, QueryError> {
-}
-/**
- * Defines a `QueryError` controller instance.
- * @group Definers
- *
- * @returns The `QueryError` controller definition.
- * */
-export declare function defineQueryError(): QueryErrorDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/query-summary/headless-query-summary.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type QuerySummary } from './headless-query-summary.js';
-export * from './headless-query-summary.js';
-export interface QuerySummaryDefinition extends ControllerDefinitionWithoutProps<SearchEngine, QuerySummary> {
-}
-/**
- * Defines a `QuerySummary` controller instance.
- * @group Definers
- *
- * @returns The `QuerySummary` controller definition.
- * */
-export declare function defineQuerySummary(): QuerySummaryDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/search-status/headless-search-status.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type SearchStatus } from './headless-search-status.js';
-export * from './headless-search-status.js';
-export interface SearchStatusDefinition extends ControllerDefinitionWithoutProps<SearchEngine, SearchStatus> {
-}
-/**
- * Defines a `SearchStatus` controller instance.
- * @group Definers
- *
- * @returns The `SearchStatus` controller definition.
- * */
-export declare function defineSearchStatus(): SearchStatusDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import type { SmartSnippetQuestionsListProps } from '../core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
-import { type SmartSnippetQuestionsList } from './headless-smart-snippet-questions-list.js';
-export * from './headless-smart-snippet-questions-list.js';
-export interface SmartSnippetQuestionsListDefinition extends ControllerDefinitionWithoutProps<SearchEngine, SmartSnippetQuestionsList> {
-}
-/**
- * Defines a `SmartSnippetQuestionsList` controller instance.
- * @group Definers
- *
- * @param props - The configurable `SmartSnippetQuestionsList` properties.
- * @returns The `SmartSnippetQuestionsList` controller definition.
- * */
-export declare function defineSmartSnippetQuestionsList(props?: SmartSnippetQuestionsListProps): SmartSnippetQuestionsListDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/static-filter/headless-static-filter.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type StaticFilter, type StaticFilterProps } from './headless-static-filter.js';
-export * from './headless-static-filter.js';
-export { buildStaticFilterValue } from './headless-static-filter.js';
-export interface StaticFilterDefinition extends ControllerDefinitionWithoutProps<SearchEngine, StaticFilter> {
-}
-/**
- * Defines a `StaticFilter` controller instance.
- * @group Definers
- *
- * @param props - The configurable `StaticFilter` properties.
- * @returns The `StaticFilter` controller definition.
- * */
-export declare function defineStaticFilter(props: StaticFilterProps): StaticFilterDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/tab-manager/headless-tab-manager.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type TabManager } from './headless-tab-manager.js';
-export * from './headless-tab-manager.js';
-interface TabManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, TabManager> {
-}
-/**
- * Defines a `TabManager` controller instance.
- * @group Definers
- *
- * @returns The `TabManager` controller definition.
- * */
-export declare function defineTabManager(): TabManagerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-execute-trigger.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import { type ExecuteTrigger } from './headless-execute-trigger.js';
-export * from './headless-execute-trigger.js';
-export interface ExecuteTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, ExecuteTrigger> {
-}
-/**
- * Defines an `ExecuteTrigger` controller instance.
- * @group Definers
- *
- * @returns The `ExecuteTrigger` controller definition.
- * */
-export declare function defineExecuteTrigger(): ExecuteTriggerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-notify-trigger.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import type { NotifyTrigger } from '../core/triggers/headless-core-notify-trigger.js';
-export type { NotifyTrigger, NotifyTriggerState, } from '../core/triggers/headless-core-notify-trigger.js';
-export interface NotifyTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NotifyTrigger> {
-}
-/**
- * Defines a `NotifyTrigger` controller instance.
- * @group Definers
- *
- * @returns The `NotifyTrigger` controller definition.
- * */
-export declare function defineNotifyTrigger(): NotifyTriggerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/triggers/headless-query-trigger.ssr.d.ts

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithoutProps } from '../../app/ssr-engine/types/common.js';
-import type { QueryTrigger } from '../core/triggers/headless-core-query-trigger.js';
-export type { QueryTrigger, QueryTriggerState, } from '../core/triggers/headless-core-query-trigger.js';
-export * from './headless-query-trigger.js';
-export interface QueryTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, QueryTrigger> {
-}
-/**
- * Defines a `QueryTrigger` controller instance.
- * @group Definers
- *
- * @returns The `QueryTrigger` controller definition.
- * */
-export declare function defineQueryTrigger(): QueryTriggerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/url-manager/headless-url-manager.ssr.d.ts

@@ -1,16 +0,0 @@
-import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { ControllerDefinitionWithProps } from '../../app/ssr-engine/types/common.js';
-import { type UrlManager, type UrlManagerInitialState } from './headless-url-manager.js';
-export * from './headless-url-manager.js';
-/**
- * @internal
- */
-export interface UrlManagerBuildProps {
-    initialState: UrlManagerInitialState;
-}
-/**
- * @internal
- * @group Definers
- *
- */
-export declare const defineUrlManager: () => ControllerDefinitionWithProps<SearchEngine, UrlManager, UrlManagerBuildProps>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/case-context/case-context-slice.spec.d.ts

@@ -1 +0,0 @@
-export {};