@coveo/atomic 3.51.0 → 3.52.0

package/dist/types/components/common/stencil-carousel.d.ts

@@ -1,15 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-import { JSXBase } from '../../stencil-public-runtime';
-import { AnyBindings } from './interface/bindings.js';
-interface CarouselProps {
-    bindings: AnyBindings;
-    previousPage(): void;
-    nextPage(): void;
-    numberOfPages: number;
-    currentPage: number;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const Carousel: FunctionalComponent<CarouselProps & JSXBase.HTMLAttributes<HTMLHeadingElement>>;
-export {};

package/dist/types/components/common/stencil-checkbox.d.ts

@@ -1,22 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export interface StencilCheckboxProps {
-    checked: boolean;
-    onToggle(checked: boolean): void;
-    key?: string | number;
-    id?: string;
-    class?: string;
-    text?: string;
-    part?: string;
-    iconPart?: string;
-    ariaLabel?: string;
-    ariaCurrent?: string;
-    ref?(element?: HTMLElement): void;
-    onMouseDown?(evt: MouseEvent): void;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const StencilCheckbox: FunctionalComponent<StencilCheckboxProps>;

package/dist/types/components/common/stencil-fieldset-group.d.ts

@@ -1,9 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-interface GroupProps {
-    label: string;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const FieldsetGroup: FunctionalComponent<GroupProps>;
-export {};

package/dist/types/components/common/stencil-heading.d.ts

@@ -1,7 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-import { JSXBase } from '../../stencil-public-runtime';
-import { HeadingProps } from './heading';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const Heading: FunctionalComponent<Pick<HeadingProps, 'level'> & JSXBase.HTMLAttributes<HTMLHeadingElement>>;

package/dist/types/components/common/stencil-hidden.d.ts

@@ -1,5 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-/**
- * @deprecated This component is no longer needed. For Lit components, render `nothing` instead.
- */
-export declare const Hidden: FunctionalComponent;

package/dist/types/components/common/stencil-iconButton.d.ts

@@ -1,13 +0,0 @@
-import { FunctionalComponent, VNode } from '../../stencil-public-runtime';
-import { StencilButtonProps } from './stencil-button';
-interface IconButtonProps extends StencilButtonProps {
-    badge?: VNode;
-    buttonRef?: (el?: HTMLButtonElement) => void;
-    icon: string;
-    partPrefix: string;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const IconButton: FunctionalComponent<IconButtonProps>;
-export {};

package/dist/types/components/common/stencil-radio-button.d.ts

@@ -1,12 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-import { RadioButtonProps } from './radio-button';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export interface StencilRadioButtonProps extends Omit<RadioButtonProps, 'ref'> {
-    ref?(element?: HTMLInputElement): void;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const RadioButton: FunctionalComponent<StencilRadioButtonProps>;

package/dist/types/components/common/stencil-switch.d.ts

@@ -1,15 +0,0 @@
-import { FunctionalComponent } from '../../stencil-public-runtime';
-interface SwitchProps {
-    checked?: boolean;
-    onToggle?(checked: boolean): void;
-    ariaLabel?: string;
-    part?: string;
-    tabIndex?: number;
-    title?: string;
-    withToggle?: boolean;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const Switch: FunctionalComponent<SwitchProps>;
-export {};

package/dist/types/components/common/stencil-triStateCheckbox.d.ts

@@ -1,11 +0,0 @@
-import { FacetValueState } from '@coveo/headless';
-import { FunctionalComponent } from '../../stencil-public-runtime';
-import { StencilCheckboxProps } from './stencil-checkbox';
-type TriStateCheckboxProps = Omit<StencilCheckboxProps, 'checked'> & {
-    state: FacetValueState;
-};
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const TriStateCheckbox: FunctionalComponent<TriStateCheckboxProps>;
-export {};

package/dist/types/components/common/suggestions/stencil-instant-item.d.ts

@@ -1,19 +0,0 @@
-import { FunctionalComponent } from '../../../stencil-public-runtime';
-import { i18n } from 'i18next';
-import { SearchBoxSuggestionElement } from './suggestions-types';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const getPartialInstantItemElement: (i18n: i18n, itemTitle: string, itemUniqueId: string) => Pick<SearchBoxSuggestionElement, "ariaLabel" | "key" | "part">;
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const getPartialInstantItemShowAllElement: (i18n: i18n) => Pick<SearchBoxSuggestionElement, "key" | "part" | "ariaLabel">;
-interface InstantItemShowAllButtonProps {
-    i18n: i18n;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const InstantItemShowAllButton: FunctionalComponent<InstantItemShowAllButtonProps>;
-export {};

package/dist/types/components/common/suggestions/stencil-query-suggestions.d.ts

@@ -1,32 +0,0 @@
-import { FunctionalComponent } from '../../../stencil-public-runtime';
-import { i18n } from 'i18next';
-import { SearchBoxSuggestionElement } from './suggestions-types.js';
-interface Suggestion {
-    highlightedValue: string;
-    rawValue: string;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const getPartialSearchBoxSuggestionElement: (suggestion: Suggestion, i18n: i18n) => Pick<SearchBoxSuggestionElement, "ariaLabel" | "key" | "query" | "part">;
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const QuerySuggestionContainer: FunctionalComponent;
-interface QuerySuggestionIconProps {
-    icon: string;
-    hasSuggestion: boolean;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const QuerySuggestionIcon: FunctionalComponent<QuerySuggestionIconProps>;
-interface QuerySuggestionTextProps {
-    suggestion: Suggestion;
-    hasQuery: boolean;
-}
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const QuerySuggestionText: FunctionalComponent<QuerySuggestionTextProps>;
-export {};

package/dist/types/components/common/suggestions/stencil-suggestion-manager.d.ts

@@ -1,96 +0,0 @@
-import type { SearchBoxSuggestionElement, SearchBoxSuggestionsBindings, SearchBoxSuggestionsEvent } from './suggestions-types';
-/**
- * List of suggestions that will be displayed along other lists (for example, recent queries) when the search box's input is selected.
- */
-export interface SearchBoxSuggestions {
-    /**
-     * The search box will sort the position of suggestions using this value, the lowest value being first.
-     * By default, the DOM position will be used.
-     */
-    position: number;
-    /**
-     * Whether the suggestions should be listed in the right or left panel. By default, the suggestions are listed in the right panel.
-     */
-    panel?: 'left' | 'right';
-    /**
-     * Method that returns the list of elements which will be rendered in the list of suggestions.
-     */
-    renderItems(): SearchBoxSuggestionElement[];
-    /**
-     * Hook called when the user changes the search box's input value. This can lead to all the query suggestions being updated.
-     */
-    onInput?(): Promise<unknown>;
-    /**
-     * Hook called when the current suggested query changes as the user navigates the list of suggestions.
-     * This is used for instant results, which are rendered based on the current suggested query.
-     * @param q The new current suggested query.
-     */
-    onSuggestedQueryChange?(q: string): Promise<unknown>;
-}
-interface SearchBoxProps {
-    getSearchBoxValue: () => string;
-    updateQuery: (suggestedQuery: string) => void;
-    getSuggestionTimeout: () => number;
-    getNumberOfSuggestionsToDisplay: () => number;
-    getSuggestionDelay: () => number;
-    getLogger: () => Pick<typeof console, 'warn'>;
-    getHost: () => HTMLElement;
-}
-export declare class SuggestionManager<SearchBoxController> {
-    private ownerSearchBoxProps;
-    suggestions: SearchBoxSuggestions[];
-    leftSuggestionElements: SearchBoxSuggestionElement[];
-    rightSuggestionElements: SearchBoxSuggestionElement[];
-    leftPanel: HTMLElement | undefined;
-    rightPanel: HTMLElement | undefined;
-    triggerSuggestions: () => Promise<void>;
-    activeDescendant: string;
-    suggestedQuery: string;
-    keyboardActiveDescendant: string;
-    private queryDataAttribute;
-    private suggestionEvents;
-    private previousActiveDescendantElement;
-    private leftSuggestions;
-    private rightSuggestions;
-    constructor(ownerSearchBoxProps: SearchBoxProps);
-    get partialSuggestionBindings(): Pick<SearchBoxSuggestionsBindings<SearchBoxController>, 'suggestedQuery' | 'clearSuggestions' | 'triggerSuggestions' | 'getSuggestions' | 'getSuggestionElements'>;
-    get activeDescendantElement(): HTMLElement | null;
-    onSubmit(): void;
-    updateActiveDescendant(id?: string): void;
-    updateKeyboardActiveDescendant(id?: string): void;
-    clickOnActiveElement(): void;
-    isRightPanelInFocus(): boolean;
-    initializeSuggestions(bindings: SearchBoxSuggestionsBindings<SearchBoxController>): void;
-    registerSuggestionsFromEvent(event: CustomEvent<SearchBoxSuggestionsEvent<SearchBoxController>>, bindings: SearchBoxSuggestionsBindings<SearchBoxController>): void;
-    registerSuggestions(suggestions: SearchBoxSuggestions): void;
-    get isDoubleList(): boolean;
-    focusPanel(side: 'left' | 'right'): void;
-    clearSuggestions(): void;
-    focusNextValue(): Promise<void>;
-    focusValue(value: HTMLElement): Promise<void>;
-    onSuggestionMouseOver(item: SearchBoxSuggestionElement, side: 'left' | 'right', id: string): Promise<void>;
-    onSuggestionClick(item: SearchBoxSuggestionElement, e: Event): Promise<void>;
-    get hasSuggestions(): boolean;
-    get allSuggestionElements(): SearchBoxSuggestionElement[];
-    focusPreviousValue(): Promise<void>;
-    get hasActiveDescendant(): boolean;
-    private executeQuerySuggestion;
-    private get lastValue();
-    private get previousOrLastValue();
-    private sortSuggestions;
-    private get nextOrFirstValue();
-    private get firstValue();
-    private get panelInFocus();
-    private scrollActiveDescendantIntoView;
-    private updateQueryFromSuggestion;
-    private updateOwnerSearchboxQuery;
-    private updateSuggestedQuery;
-    private updateSuggestionElements;
-    forceUpdate(): void;
-    private isPanelInFocus;
-    private getAndFilterLeftSuggestionElements;
-    private getSuggestionElements;
-    private updateDescendants;
-    private clearSuggestionElements;
-}
-export {};

package/dist/types/components/insight/result-templates/atomic-insight-result-children-template/atomic-insight-result-children-template.d.ts

@@ -1,50 +0,0 @@
-import { ResultTemplate, ResultTemplateCondition } from '@coveo/headless';
-import { ResultTemplateCommon } from '../../../common/result-templates/stencil-result-template-common';
-/**
- * @internal
- */
-export declare class AtomicInsightResultChildrenTemplate {
-    host: HTMLDivElement;
-    error: Error;
-    /**
-     * A function that must return true on results for the result template to apply.
-     * Set programmatically before initialization, not via attribute.
-     *
-     * For example, the following targets a template and sets a condition to make it apply only to results whose `title` contains `singapore`:
-     * `document.querySelector('#target-template').conditions = [(result) => /singapore/i.test(result.title)];`
-     */
-    conditions: ResultTemplateCondition[];
-    /**
-     * The field that, when defined on a result item, would allow the template to be applied.
-     *
-     * For example, a template with the following attribute only applies to result items whose `filetype` and `sourcetype` fields are defined: `if-defined="filetype,sourcetype"`
-     */
-    ifDefined?: string;
-    /**
-     * The field that, when defined on a result item, would prevent the template from being applied.
-     *
-     * For example, a template with the following attribute only applies to result items whose `filetype` and `sourcetype` fields are NOT defined: `if-not-defined="filetype,sourcetype"`
-     */
-    ifNotDefined?: string;
-    /**
-     * The field and values that define which result items the condition must be applied to.
-     *
-     * For example, a template with the following attribute only applies to result items whose `filetype` is `lithiummessage` or `YouTubePlaylist`: `must-match-filetype="lithiummessage,YouTubePlaylist"`
-     */
-    mustMatch: Record<string, string[]>;
-    /**
-     * The field and values that define which result items the condition must not be applied to.
-     *
-     * For example, a template with the following attribute only applies to result items whose `filetype` is not `lithiummessage`: `must-not-match-filetype="lithiummessage"`
-     */
-    mustNotMatch: Record<string, string[]>;
-    resultTemplateCommon: ResultTemplateCommon;
-    constructor();
-    connectedCallback(): void;
-    componentWillLoad(): void;
-    /**
-     * Gets the appropriate result template based on conditions applied.
-     */
-    getTemplate(): Promise<ResultTemplate<DocumentFragment> | null>;
-    render(): any;
-}

package/dist/types/components/search/facets/facet-segmented-value/stencil-facet-segmented-value.d.ts

@@ -1,6 +0,0 @@
-import { FunctionalComponent } from '../../../../stencil-public-runtime';
-import { FacetValueProps } from '../../../common/facets/stencil-facet-common';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const FacetSegmentedValue: FunctionalComponent<FacetValueProps>;

package/dist/types/components/search/result-template-component-utils/context/stencil-result-template-decorators.d.ts

@@ -1,32 +0,0 @@
-import { FoldedResult, Result } from '@coveo/headless';
-import { InteractiveItemContextEvent, ItemContextEvent } from "../../../common/item-list/stencil-item-decorators";
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) to be used for result template components.
- * This allows the Stencil component to fetch the current result from its rendered parent, the `atomic-result` component.
- *
- * Example:
- * @ResultContext() private result!: Result;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `createResultContextController` from \@/src/components/search/result-template-component-utils/context/result-context-controller.ts
- */
-export declare function ResultContext(opts?: {
-    folded: boolean;
-}): (component: import("@stencil/core").ComponentInterface, itemVariable: string) => void;
-export declare function InteractiveResultContext(): (component: import("@stencil/core").ComponentInterface, interactiveItemVariable: string) => void;
-export type ResultContextEvent<T = Result> = ItemContextEvent<T>;
-export type InteractiveResultContextEvent = InteractiveItemContextEvent;
-/**
- * Retrieves `Result` on a rendered `atomic-result`.
- *
- * This method is useful for building custom result template elements, see [Create a Result List](https://docs.coveo.com/en/atomic/latest/cc-search/create-custom-components/native-components/#custom-result-template-component-example) for more information.
- *
- * You should use the method in the [connectedCallback lifecycle method](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).
- *
- * @param element The element that the event is dispatched to, which must be the child of a rendered "atomic-result" element.
- * @returns A promise that resolves on initialization of the parent "atomic-result" element, or rejects when there is no parent "atomic-result" element.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `fetchResultContext` from \@/src/components/search/result-template-component-utils/context/fetch-result-context.ts
- */
-export declare function resultContext<T extends Result | FoldedResult = Result>(element: Element): Promise<T>;

package/dist/types/components/search/result-template-components/quickview-iframe/stencil-quickview-iframe.d.ts

@@ -1,14 +0,0 @@
-import { SearchEngine } from '@coveo/headless';
-import { FunctionalComponent } from '../../../../stencil-public-runtime';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const QuickviewIframe: FunctionalComponent<{
-    title: string;
-    content?: string;
-    onSetIframeRef: (ref: HTMLIFrameElement) => void;
-    uniqueIdentifier?: string;
-    sandbox?: string;
-    src?: string;
-    logger?: SearchEngine['logger'];
-}>;

package/dist/types/utils/__mocks__/stencil-resource-url.d.ts

@@ -1 +0,0 @@
-export declare const getResourceUrl: () => undefined;

package/dist/types/utils/initialization-utils.d.ts

@@ -1,70 +0,0 @@
-import { ComponentInterface } from '../stencil-public-runtime';
-import { TOptions } from 'i18next';
-import { AnyBindings } from '../components/common/interface/bindings';
-import { Bindings } from '../components/search/atomic-search-interface/atomic-search-interface';
-import { InitializeEventHandler } from './initialization-lit-stencil-common-utils';
-export type InitializeEvent = CustomEvent<InitializeEventHandler>;
-/**
- * Retrieves `Bindings` or `CommerceBindings` on a configured parent interface.
- * @param event - The element on which to dispatch the event, which must be the child of a configured Atomic container element.
- * @returns A promise that resolves upon initialization of the parent container element, and rejects otherwise.
- */
-export declare function initializeBindings<SpecificBindings extends AnyBindings = Bindings>(element: Element): Promise<SpecificBindings>;
-export { MissingInterfaceParentError, InitializeEventHandler, initializeEventName, } from './initialization-lit-stencil-common-utils';
-/**
- * Necessary interface an Atomic Component must have to initialize itself correctly.
- * @deprecated To be used for Stencil components. For Lit components. use `InitializableComponent` from './decorators/types/'
- */
-export interface InitializableComponent<SpecificBindings extends AnyBindings = Bindings> extends ComponentInterface {
-    /**
-     * Bindings passed from the `AtomicSearchInterface` to its children components.
-     */
-    bindings: SpecificBindings;
-    /**
-     * Method called right after the `bindings` property is defined. This is the method where Headless Framework controllers should be initialized.
-     */
-    initialize?: () => void;
-    error: Error;
-}
-type InitializeBindingsProps = {
-    forceUpdate?: boolean;
-};
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) to be used on a property named `bindings`.
- * This will automatically fetch the `Bindings` from the parent `atomic-search-interface` or `atomic-external` components.
- *
- * Once a component is bound, the `initialize` method is called.
- * In the event of an initialization error, the `error` property will be set and an `atomic-component-error` will be rendered.
- *
- * In order for a component using this decorator to render properly, it should have an internal state bound to one of the properties from `bindings`.
- * This is possible by using the `BindStateToController` decorator.
- *
- * @example
- * @InitializeBindings() public bindings!: Bindings;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- * @deprecated To be used for Stencil components. For Lit components, use `BindingController` Reactive Controller from @/mixins/bindings-mixin.ts.
- */
-export declare function InitializeBindings<SpecificBindings extends AnyBindings>({ forceUpdate, }?: InitializeBindingsProps): (component: InitializableComponent<SpecificBindings>, bindingsProperty: string) => void;
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) is used together with the [State decorator](https://stenciljs.com/docs/state#state-decorator).
- * This allows the Stencil component state property to automatically get updates from a [Coveo Headless controller](https://docs.coveo.com/en/headless/latest/usage/#use-headless-controllers).
- *
- * @example
- * @BindStateToController('pager') @State() private pagerState!: PagerState;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- *
- * @param controllerProperty The controller property to subscribe to. The controller has to be created inside of the `initialize` method.
- * @param options The configurable `BindStateToController` options.
- *
- * @deprecated To be used for Stencil components. For Lit components. use `bindStateToController` from '../decorators/bind-state.ts'
- */
-export declare function BindStateToController(controllerProperty: string, options?: {
-    /**
-     * Component's method to be called when state is updated.
-     */
-    onUpdateCallbackMethod?: string;
-}): (component: InitializableComponent<AnyBindings>, stateProperty: string) => void;
-export declare function DeferUntilRender(): (component: ComponentInterface, methodName: string) => void;
-export type I18nState = Record<string, (variables?: TOptions) => string>;

package/dist/types/utils/jsx-utils.d.ts

@@ -1,6 +0,0 @@
-import { FunctionalComponent } from '../stencil-public-runtime';
-import { LocalizedStringProps } from '../directives/localized-string';
-/**
- * @deprecated Should only be used for Stencil components; for Lit components, use the localizedString directive instead
- */
-export declare const LocalizedString: FunctionalComponent<LocalizedStringProps>;

package/dist/types/utils/stencil-accessibility-utils.d.ts

@@ -1,43 +0,0 @@
-import { AtomicAriaLive } from '../components/common/atomic-aria-live/atomic-aria-live';
-import { AnyBindings } from '../components/common/interface/bindings';
-import { InitializableComponent } from './initialization-utils';
-/**
- * @deprecated use Lit equivalent
- */
-export interface FindAriaLiveEventArgs {
-    element?: AtomicAriaLive;
-}
-/**
- * @deprecated use Lit equivalent
- */
-export declare function AriaLiveRegion(regionName: string, assertive?: boolean): (component: InitializableComponent<AnyBindings>, setterName: string) => void;
-/**
- * @deprecated use Lit equivalent
- */
-export declare class FocusTargetController {
-    private component;
-    private bindings;
-    private lastSearchId?;
-    private element?;
-    registerFocusCallback: (callback: Function) => void;
-    private internalOnFocusCallback?;
-    private doFocusAfterSearch;
-    private doFocusOnNextTarget;
-    private publicOnFocusCallbacks;
-    constructor(component: InitializableComponent<AnyBindings>);
-    private clearFocusCallbacks;
-    setTarget(el: HTMLElement | undefined): void;
-    focus(): Promise<void>;
-    focusAfterSearch(): Promise<unknown>;
-    focusOnNextTarget(): Promise<unknown>;
-    disableForCurrentSearch(): void;
-    private handleComponentRenderLoop;
-}
-/**
- * @deprecated use Lit equivalent
- */
-export declare function getFocusableDescendants(element: Element): Generator<HTMLElement>;
-/**
- * @deprecated use Lit equivalent
- */
-export declare function getFirstFocusableDescendant(element: Element): HTMLElement | null;

package/dist/types/utils/stencil-asset-path-utils.d.ts

@@ -1 +0,0 @@
-export declare function getAssetPath(path: string): string;

package/dist/types/utils/stencil-resource-url.d.ts

@@ -1 +0,0 @@
-export declare const getResourceUrl: () => string;