@coveo/atomic 3.35.0-pre.ddf08ff320 → 3.35.0-pre.e19cc0d9a2

package/dist/types/components/common/no-items/stencil-guard.d.ts

@@ -4,5 +4,8 @@ interface NoItemsGuardProps {
     isLoading: boolean;
     hasResults: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const NoItemsGuard: FunctionalComponent<NoItemsGuardProps>;
 export {};

package/dist/types/components/common/no-items/stencil-magnifying-glass.d.ts

@@ -1,2 +1,5 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const MagnifyingGlass: FunctionalComponent;

package/dist/types/components/common/no-items/stencil-no-items.d.ts

@@ -5,5 +5,8 @@ interface NoItemsProps {
     i18n: i18n;
     i18nKey: 'no-results' | 'no-products';
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const NoItems: FunctionalComponent<NoItemsProps>;
 export {};

package/dist/types/components/common/no-items/stencil-tips.d.ts

@@ -3,5 +3,8 @@ import { i18n } from 'i18next';
 interface SearchTipsProps {
     i18n: i18n;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SearchTips: FunctionalComponent<SearchTipsProps>;
 export {};

package/dist/types/components/common/pager/stencil-pager-buttons.d.ts

@@ -2,40 +2,32 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 import { i18n } from 'i18next';
 import { StencilButtonProps } from '../stencil-button';
 import { StencilRadioButtonProps } from '../stencil-radio-button';
-/**
- * @deprecated use the lit equivalent
- */
-export interface PagerNavigationButtonProps extends Omit<StencilButtonProps, 'style' | 'part' | 'class'> {
+interface PagerNavigationButtonProps extends Omit<StencilButtonProps, 'style' | 'part' | 'class'> {
     icon: string;
     i18n: i18n;
 }
-/**
- * @deprecated use the lit equivalent
- */
-export interface PagerPageButtonProps extends Omit<StencilRadioButtonProps, 'part' | 'style' | 'checked' | 'ariaCurrent' | 'key' | 'class' | 'ref'> {
+interface PagerPageButtonProps extends Omit<StencilRadioButtonProps, 'part' | 'style' | 'checked' | 'ariaCurrent' | 'key' | 'class' | 'ref'> {
     page: number;
     isSelected: boolean;
     text: string;
 }
-/**
- * @deprecated use the lit equivalent
- */
-export interface PagerPageButtonsProps {
+interface PagerPageButtonsProps {
     i18n: i18n;
 }
 /**
- * @deprecated use the lit equivalent
+ * @deprecated should only be used for Stencil components.
  */
 export declare const PagerPreviousButton: FunctionalComponent<PagerNavigationButtonProps>;
 /**
- * @deprecated use the lit equivalent
+ * @deprecated should only be used for Stencil components.
  */
 export declare const PagerNextButton: FunctionalComponent<PagerNavigationButtonProps>;
 /**
- * @deprecated use the lit equivalent
+ * @deprecated should only be used for Stencil components.
  */
 export declare const PagerPageButton: FunctionalComponent<PagerPageButtonProps>;
 /**
- * @deprecated use the lit equivalent
+ * @deprecated should only be used for Stencil components.
  */
 export declare const PagerPageButtons: FunctionalComponent<PagerPageButtonsProps>;
+export {};

package/dist/types/components/common/pager/stencil-pager-navigation.d.ts

@@ -1,12 +1,10 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
 import { i18n } from 'i18next';
-/**
- * @deprecated use the lit equivalent
- */
-export interface PagerNavigationProps {
+interface PagerNavigationProps {
     i18n: i18n;
 }
 /**
- * @deprecated use the lit equivalent
+ * @deprecated should only be used for Stencil components.
  */
 export declare const PagerNavigation: FunctionalComponent<PagerNavigationProps>;
+export {};

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

@@ -5,5 +5,8 @@ interface AutoCorrectionProps {
     originalQuery: string;
     correctedTo: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const AutoCorrection: FunctionalComponent<AutoCorrectionProps>;
 export {};

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

@@ -5,5 +5,8 @@ interface CorrectionProps {
     onClick: () => void;
     correctedQuery: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const Correction: FunctionalComponent<CorrectionProps>;
 export {};

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

@@ -2,5 +2,8 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 interface QueryCorrectionGuardProps {
     hasCorrection: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryCorrectionGuard: FunctionalComponent<QueryCorrectionGuardProps>;
 export {};

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

@@ -6,5 +6,8 @@ interface TriggerCorrectionProps {
     originalQuery: string;
     onClick: () => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const TriggerCorrection: FunctionalComponent<TriggerCorrectionProps>;
 export {};

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

@@ -1,2 +1,5 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorContainer: FunctionalComponent;

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

@@ -6,5 +6,8 @@ interface QueryErrorDescriptionProps {
     url: string;
     organizationId: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorDescription: FunctionalComponent<QueryErrorDescriptionProps>;
 export {};

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

@@ -3,5 +3,8 @@ interface QueryErrorDetailsProps {
     error: unknown;
     show: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorDetails: FunctionalComponent<QueryErrorDetailsProps>;
 export {};

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

@@ -2,5 +2,8 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 interface QueryErrorGuardProps {
     hasError: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorGuard: FunctionalComponent<QueryErrorGuardProps>;
 export {};

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

@@ -2,5 +2,8 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 interface QueryErrorIconProps {
     errorType?: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorIcon: FunctionalComponent<QueryErrorIconProps>;
 export {};

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

@@ -4,5 +4,8 @@ interface QueryErrorLinkProps {
     errorType?: string;
     i18n: i18n;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorLink: FunctionalComponent<QueryErrorLinkProps>;
 export {};

package/dist/types/components/common/query-error/stencil-show-more.d.ts

@@ -6,5 +6,8 @@ interface QueryErrorShowMoreProps {
     i18n: i18n;
     link?: typeof QueryErrorLink;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorShowMore: FunctionalComponent<QueryErrorShowMoreProps>;
 export {};

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

@@ -5,5 +5,8 @@ interface QueryErrorTitleProps {
     i18n: i18n;
     organizationId: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QueryErrorTitle: FunctionalComponent<QueryErrorTitleProps>;
 export {};

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

@@ -2,5 +2,8 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 interface QuerySummaryContainerProps {
     additionalClasses?: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QuerySummaryContainer: FunctionalComponent<QuerySummaryContainerProps>;
 export {};

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

@@ -4,5 +4,8 @@ interface QuerySummaryGuardProps {
     hasError: boolean;
     firstSearchExecuted: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const QuerySummaryGuard: FunctionalComponent<QuerySummaryGuardProps>;
 export {};

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

@@ -7,6 +7,9 @@ interface i18nKeyProps {
     isLoading: boolean;
     i18n: i18n;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const getQuerySummaryI18nParameters: (props: i18nKeyProps) => {
     i18nKey: string;
     highlights: {
@@ -17,14 +20,4 @@ export declare const getQuerySummaryI18nParameters: (props: i18nKeyProps) => {
     };
     ariaLiveMessage: string;
 };
-export declare const getProductQuerySummaryI18nParameters: (props: i18nKeyProps) => {
-    i18nKey: string;
-    highlights: {
-        first: any;
-        last: any;
-        total: any;
-        query: any;
-    };
-    ariaLiveMessage: string;
-};
 export {};

package/dist/types/components/common/refine-modal/stencil-body.d.ts

@@ -1,2 +1,5 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineModalBody: FunctionalComponent;

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

@@ -5,5 +5,8 @@ interface RefineToggleButtonProps {
     onClick: () => void;
     setRef: (button: HTMLButtonElement) => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineToggleButton: FunctionalComponent<RefineToggleButtonProps>;
 export {};

package/dist/types/components/common/refine-modal/stencil-filters.d.ts

@@ -5,10 +5,16 @@ interface RefineModalFiltersSectionProps {
     withFacets: boolean;
     withAutomaticFacets: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineModalFiltersSection: FunctionalComponent<RefineModalFiltersSectionProps>;
 interface RefineModalFiltersClearButtonProps {
     i18n: i18n;
     onClick: () => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineModalFiltersClearButton: FunctionalComponent<RefineModalFiltersClearButtonProps>;
 export {};

package/dist/types/components/common/refine-modal/stencil-guard.d.ts

@@ -4,5 +4,8 @@ interface RefineToggleGuardProps {
     firstRequestExecuted: boolean;
     hasItems: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineToggleGuard: FunctionalComponent<RefineToggleGuardProps>;
 export {};

package/dist/types/components/common/refine-modal/stencil-modal.d.ts

@@ -11,5 +11,8 @@ interface RefineModalProps {
     boundary?: 'page' | 'element';
     scope?: HTMLElement;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineModal: FunctionalComponent<RefineModalProps>;
 export {};

package/dist/types/components/common/refine-modal/stencil-sort.d.ts

@@ -4,5 +4,8 @@ interface RefineModalSortSectionProps {
     i18n: i18n;
     onSelect: (e: Event) => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const RefineModalSortSection: FunctionalComponent<RefineModalSortSectionProps>;
 export {};

package/dist/types/components/common/result-children/children-wrapper.d.ts

@@ -2,5 +2,8 @@ import { FunctionalComponent } from '../../../stencil-public-runtime';
 interface ChildrenWrapperProps {
     hasChildren: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const ChildrenWrapper: FunctionalComponent<ChildrenWrapperProps>;
 export {};

package/dist/types/components/common/result-children/collection-guard.d.ts

@@ -9,5 +9,8 @@ interface CollectionGuardProps {
     imageSize: ItemDisplayImageSize;
     noResultText: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const CollectionGuard: FunctionalComponent<CollectionGuardProps>;
 export {};

package/dist/types/components/common/result-children/guard.d.ts

@@ -4,5 +4,8 @@ interface ResultChildrenGuardProps {
     resultTemplateRegistered: boolean;
     templateHasError: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const ResultChildrenGuard: FunctionalComponent<ResultChildrenGuardProps>;
 export {};

package/dist/types/components/common/result-children/show-hide-button.d.ts

@@ -7,5 +7,8 @@ interface ShowHideButtonProps {
     loadAllResults: string;
     collapseResults: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const ShowHideButton: FunctionalComponent<ShowHideButtonProps>;
 export {};

package/dist/types/components/common/search-box/stencil-search-box-wrapper.d.ts

@@ -3,5 +3,8 @@ interface Props {
     disabled: boolean;
     onFocusout?: (event: FocusEvent) => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SearchBoxWrapper: FunctionalComponent<Props>;
 export {};

package/dist/types/components/common/search-box/stencil-search-text-area.d.ts

@@ -15,5 +15,8 @@ interface Props extends JSXBase.TextareaHTMLAttributes<HTMLTextAreaElement> {
         hasSuggestions: boolean;
     };
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SearchTextArea: FunctionalComponent<Props>;
 export {};

package/dist/types/components/common/search-box/stencil-submit-button.d.ts

@@ -5,5 +5,8 @@ interface Props {
     disabled: boolean;
     onClick: () => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SubmitButton: FunctionalComponent<Props>;
 export {};

package/dist/types/components/common/search-box/stencil-text-area-clear-button.d.ts

@@ -5,5 +5,8 @@ interface Props extends Partial<StencilButtonProps> {
     bindings: AnyBindings;
     inputRef: HTMLInputElement | HTMLTextAreaElement | null;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const TextAreaClearButton: FunctionalComponent<Props>;
 export {};

package/dist/types/components/common/smart-snippets/atomic-smart-snippet/smart-snippet-common.d.ts

@@ -1,21 +1,31 @@
 import { FunctionalComponent } from '../../../../stencil-public-runtime';
 import { i18n } from 'i18next';
-export interface SmartSnippetQuestionProps {
-    headingLevel?: number;
-    question: string;
-}
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetWrapper: FunctionalComponent<{
     headingLevel?: number;
     i18n: i18n;
 }>;
-export declare const SmartSnippetQuestion: FunctionalComponent<{
+interface SmartSnippetQuestionProps {
     headingLevel?: number;
     question: string;
-}>;
+}
+/**
+ * @deprecated should only be used for Stencil components.
+ */
+export declare const SmartSnippetQuestion: FunctionalComponent<SmartSnippetQuestionProps>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetTruncatedAnswer: FunctionalComponent<{
     answer: string;
     style?: string;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFooter: FunctionalComponent<{
     i18n: i18n;
 }>;
+export {};

package/dist/types/components/common/smart-snippets/atomic-smart-snippet-feedback-banner.d.ts

@@ -11,5 +11,8 @@ interface SmartSnippetFeedbackBannerProps {
     onPressExplainWhy(): void;
     explainWhyRef?(element?: HTMLButtonElement): void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackBanner: FunctionalComponent<SmartSnippetFeedbackBannerProps>;
 export {};

package/dist/types/components/common/smart-snippets/atomic-smart-snippet-feedback-modal/smart-snippet-feedback-modal-common.d.ts

@@ -1,16 +1,28 @@
 import type { SmartSnippetFeedback } from '@coveo/headless';
 import { FunctionalComponent } from '../../../../stencil-public-runtime';
 import { i18n } from 'i18next';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackModalHeader: FunctionalComponent<{
     i18n: i18n;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackModalBody: FunctionalComponent<{
     formId: string;
     onSubmit: (e: Event) => void;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeebackModalOptions: FunctionalComponent<{
     i18n: i18n;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackModalOption: FunctionalComponent<{
     correspondingAnswer: SmartSnippetFeedback | 'other';
     currentAnswer?: SmartSnippetFeedback | 'other';
@@ -19,16 +31,25 @@ export declare const SmartSnippetFeedbackModalOption: FunctionalComponent<{
     localeKey: string;
     onChange: (e: Event) => void;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackModalDetails: FunctionalComponent<{
     currentAnswer?: SmartSnippetFeedback | 'other';
     i18n: i18n;
     setDetailsInputRef: (ref?: HTMLTextAreaElement) => void;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetFeedbackModalFooter: FunctionalComponent<{
     formId: string;
     i18n: i18n;
     onClick: (e: MouseEvent) => void;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const smartSnippetFeedbackOptions: {
     id: string;
     localeKey: string;

package/dist/types/components/common/smart-snippets/atomic-smart-snippet-suggestions/smart-snippet-suggestions-common.d.ts

@@ -1,13 +1,22 @@
 import { FunctionalComponent } from '../../../../stencil-public-runtime';
 import { i18n } from 'i18next';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetSuggestionsWrapper: FunctionalComponent<{
     headingLevel: number;
     i18n: i18n;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetSuggestionsQuestionWrapper: FunctionalComponent<{
     expanded: boolean;
     key: string;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetSuggestionsQuestion: FunctionalComponent<{
     ariaControls: string;
     expanded: boolean;
@@ -15,11 +24,20 @@ export declare const SmartSnippetSuggestionsQuestion: FunctionalComponent<{
     onClick: (event: MouseEvent) => void;
     question: string;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetSuggestionsAnswerAndSourceWrapper: FunctionalComponent<{
     expanded: boolean;
     id: string;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SmartSnippetSuggestionsFooter: FunctionalComponent<{
     i18n: i18n;
 }>;
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const getQuestionPart: (base: string, expanded: boolean) => string;

package/dist/types/components/common/sort/container.d.ts

@@ -1,2 +1,5 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SortContainer: FunctionalComponent;

package/dist/types/components/common/sort/stencil-guard.d.ts

@@ -4,5 +4,8 @@ interface SortGuardProps {
     firstSearchExecuted: boolean;
     hasResults: boolean;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SortGuard: FunctionalComponent<SortGuardProps>;
 export {};

package/dist/types/components/common/sort/stencil-label.d.ts

@@ -4,5 +4,8 @@ interface SortLabelProps {
     id: string;
     i18n: i18n;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SortLabel: FunctionalComponent<SortLabelProps>;
 export {};

package/dist/types/components/common/sort/stencil-option.d.ts

@@ -1,9 +1,13 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
 import { i18n } from 'i18next';
-export interface SortOptionProps {
+interface SortOptionProps {
     value: string;
     selected: boolean;
     i18n: i18n;
     label: string;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SortOption: FunctionalComponent<SortOptionProps>;
+export {};

package/dist/types/components/common/sort/stencil-select.d.ts

@@ -5,5 +5,8 @@ interface SortSelectProps {
     i18n: i18n;
     onSelect: (opt: Event) => void;
 }
+/**
+ * @deprecated should only be used for Stencil components.
+ */
 export declare const SortSelect: FunctionalComponent<SortSelectProps>;
 export {};

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

@@ -1,7 +1,7 @@
 import { FunctionalComponent } from '../../stencil-public-runtime';
 import { ButtonStyle } from './stencil-button-style';
 /**
- * @deprecated Should only be used for Stencil components; for Lit components, use ButtonProps interface instead
+ * @deprecated should only be used for Stencil components.
  */
 export interface StencilButtonProps {
     style: ButtonStyle;
@@ -25,6 +25,6 @@ export interface StencilButtonProps {
     ref?(element?: HTMLButtonElement): void;
 }
 /**
- * @deprecated Should only be used for Stencil components; for Lit components, use the button.ts file instead
+ * @deprecated should only be used for Stencil components.
  */
 export declare const Button: FunctionalComponent<StencilButtonProps>;

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

@@ -1,11 +1,15 @@
 import { FunctionalComponent } from '../../stencil-public-runtime';
 import { JSXBase } from '../../stencil-public-runtime';
 import { AnyBindings } from './interface/bindings.js';
-export interface CarouselProps {
+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 {};