@coveo/atomic 3.50.0 → 3.52.0

package/dist/types/components/ipx/atomic-ipx-recs-list/{atomic-recs-list/atomic-ipx-recs-list.d.ts → atomic-ipx-recs-list.d.ts}

@@ -1,38 +1,48 @@
-import { RecommendationList, RecommendationListState } from '@coveo/headless/recommendation';
-import { InitializableComponent } from '../../../../utils/initialization-utils';
-import { FocusTargetController } from '../../../../utils/stencil-accessibility-utils';
-import { ItemRenderingFunction } from '../../../common/item-list/stencil-item-list-common';
-import { ItemDisplayBasicLayout, ItemDisplayDensity, ItemDisplayImageSize } from '../../../common/layout/display-options';
-import { RecsBindings } from '../../../recommendations/atomic-recs-interface/atomic-recs-interface';
+import { type RecommendationList, type RecommendationListState } from '@coveo/headless/recommendation';
+import { type CSSResultGroup, LitElement, nothing } from 'lit';
+import { type ItemRenderingFunction } from "../../common/item-list/item-list-common";
+import { type ItemDisplayBasicLayout, type ItemDisplayDensity, type ItemDisplayImageSize } from "../../common/layout/item-layout-utils";
+import type { RecsBindings } from "../../recommendations/atomic-recs-interface/interfaces";
+import type { InitializableComponent } from "../../../decorators/types";
+import "../../recommendations/atomic-recs-result/atomic-recs-result";
+declare const AtomicIpxRecsList_base: typeof LitElement;
 /**
  * The `atomic-ipx-recs-list` component displays recommendations by applying one or more result templates.
  *
  * @part result-list - The element containing the list of results.
  * @part result-list-grid-clickable-container - The parent of the result and the clickable link encompassing it.
- * @part result-list-grid-clickable - The clickable link encompassing the result.
+ * @part outline - The outline element around a result in the grid layout.
  * @part label - The label of the result list.
  * @part previous-button - The previous button.
  * @part next-button - The next button.
+ * @part previous-icon - The previous button icon.
+ * @part next-icon - The next button icon.
+ * @part carousel - The carousel container.
  * @part indicators - The list of indicators.
  * @part indicator - A single indicator.
  * @part active-indicator - The active indicator.
- * @internal
+ *
+ * @slot default - The default slot where the result templates are defined.
+ *
+ * @cssprop --atomic-recs-number-of-columns - The number of columns in the grid.
  */
-export declare class AtomicIPXRecsList implements InitializableComponent<RecsBindings> {
-    bindings: RecsBindings;
+export declare class AtomicIpxRecsList extends AtomicIpxRecsList_base implements InitializableComponent<RecsBindings> {
+    static styles: CSSResultGroup;
+    private static readonly propsSchema;
     recommendationList: RecommendationList;
-    private loadingFlag;
+    private actionsHistoryActions?;
     private itemRenderingFunction;
+    private itemListCommon;
     private itemTemplateProvider;
+    private loadingFlag;
     private nextNewResultTarget?;
-    private itemListCommon;
-    private actionsHistoryActions?;
-    host: HTMLDivElement;
+    bindings: RecsBindings;
     error: Error;
+    private currentPage;
     private isAppLoaded;
+    private isEveryResultReady;
     private resultTemplateRegistered;
     private templateHasError;
-    private currentPage;
     recommendationListState: RecommendationListState;
     /**
      * The Recommendation identifier used by the Coveo platform to retrieve recommended documents.
@@ -59,19 +69,21 @@ export declare class AtomicIPXRecsList implements InitializableComponent<RecsBin
     numberOfRecommendations: number;
     /**
      * The number of recommendations to display, per page.
-     * Setting a value greater than and lower than the numberOfRecommendations value activates the carousel.
+     * Setting a value greater than 0 and lower than the numberOfRecommendations value activates the carousel.
      * This does not affect the display of the list itself, only the number of recommendation pages.
      */
     numberOfRecommendationsPerPage?: number;
     /**
      * The non-localized label for the list of recommendations.
+     * This will also set the `originLevel2` (tab) of the analytics requests.
      */
     label?: string;
     /**
      * The [heading level](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements) to use for the heading label, from 1 to 6.
+     * When set to 0, a `div` will be used instead of a Heading Element.
      */
     headingLevel: number;
-    watchNumberOfRecommendationsPerPage(): Promise<void>;
+    constructor();
     /**
      * Sets a rendering function to bypass the standard HTML template mechanism for rendering results.
      * You can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.
@@ -90,21 +102,31 @@ export declare class AtomicIPXRecsList implements InitializableComponent<RecsBin
      */
     nextPage(): Promise<void>;
     initialize(): void;
-    get focusTarget(): FocusTargetController;
+    willUpdate(changedProperties: Map<string, unknown>): Promise<void>;
+    private updateResultsReadyState;
+    private get focusTarget();
     private get recommendationListStateWithAugment();
     private validateNumberOfRecommendationsPerPage;
     private validateRecommendationIdentifier;
     private updateOriginLevel2;
-    private renderHeading;
     private get currentIndex();
     private get subsetRecommendations();
     private get numberOfPages();
     private get hasPagination();
     private get shouldRenderPagination();
+    private get hasNoResults();
     private onSelect;
     private getPropsForAtomicRecsResult;
     private computeListDisplayClasses;
+    private renderHeading;
     private renderAsGrid;
-    private renderListOfRecommendations;
-    render(): any;
+    private renderRecommendationList;
+    private get shouldRender();
+    render(): import("lit-html").TemplateResult<1> | typeof nothing;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-ipx-recs-list': AtomicIpxRecsList;
+    }
 }
+export {};

package/dist/types/components/ipx/atomic-ipx-refine-modal/atomic-ipx-refine-modal.d.ts

@@ -1,17 +1,49 @@
-import { BreadcrumbManagerState, QuerySummary, QuerySummaryState } from '@coveo/headless';
-import { InitializableComponent } from '../../../utils/initialization-utils';
-import { Bindings } from '../../search/atomic-search-interface/atomic-search-interface';
+import { type BreadcrumbManager, type BreadcrumbManagerState, type QuerySummary, type QuerySummaryState } from '@coveo/headless';
+import { type CSSResultGroup, LitElement } from 'lit';
+import type { Bindings } from "../../search/atomic-search-interface/atomic-search-interface";
+import type { InitializableComponent } from "../../../decorators/types";
 /**
- * @internal
+ * The `atomic-ipx-refine-modal` component is automatically created as a child of the `atomic-search-interface` when the `atomic-ipx-refine-toggle` is initialized.
+ *
+ * When the modal is opened, the class `atomic-modal-opened` is added to the interface element and the body.
+ *
+ * @slot facets - Slot for facet elements to be displayed in the modal. This slot is managed internally by the component and should not be used directly.
+ *
+ * @part title - The title of the modal.
+ * @part close-button - The button in the header that closes the modal.
+ * @part close-icon - The icon of the close button.
+ * @part content - The wrapper around the content inside the body of the modal.
+ * @part section-title - The title for each section.
+ * @part section-filters-title - The title for the filters section.
+ * @part filter-section - The section containing facets and the "filters" title.
+ * @part filter-clear-all - The button that resets all actively selected facet values.
+ * @part footer-content - The wrapper around the content inside the footer of the modal, containing the button to view results.
+ * @part footer-button - The button in the footer that closes the modal.
+ * @part footer-button-text - The text inside the button in the footer that closes the modal.
+ * @part footer-button-count - The count inside the button in the footer that closes the modal.
+ * @part footer-wrapper - The wrapper with a shadow or background color around the footer.
+ * @part footer - The footer of the modal.
+ * @part header-ruler - The horizontal ruler underneath the header.
+ * @part body-wrapper - The wrapper around the body.
+ * @part body - The body of the modal, between the header and the footer.
+ * @part header-wrapper - The wrapper around the header.
+ * @part header - The header of the modal, containing the title.
+ * @part container - The modal's outermost container.
+ * @part backdrop - The transparent backdrop hiding the content behind the modal.
+ *
+ * @cssprop --atomic-refine-modal-facet-margin - The margin between facets in the refine modal. Default is `20px`.
  */
-export declare class AtomicIPXRefineModal implements InitializableComponent {
+export declare class AtomicIpxRefineModal extends LitElement implements InitializableComponent<Bindings> {
+    static styles: CSSResultGroup;
     bindings: Bindings;
-    host: HTMLElement;
-    querySummaryState: QuerySummaryState;
-    breadcrumbManagerState: BreadcrumbManagerState;
     error: Error;
-    interfaceDimensions?: DOMRect;
+    /**
+     * The element that opens the modal when clicked.
+     */
     openButton?: HTMLElement;
+    /**
+     * Whether the modal is open.
+     */
     isOpen: boolean;
     /**
      * The number of expanded facets inside the refine modal.
@@ -20,12 +52,27 @@ export declare class AtomicIPXRefineModal implements InitializableComponent {
      * Using the value `0` collapses all facets.
      */
     collapseFacetsAfter: number;
-    private breadcrumbManager;
+    breadcrumbManager: BreadcrumbManager;
+    breadcrumbManagerState: BreadcrumbManagerState;
     querySummary: QuerySummary;
-    watchEnabled(isOpen: boolean): void;
+    querySummaryState: QuerySummaryState;
     initialize(): void;
-    private renderHeader;
-    private renderBody;
-    render(): any;
-    componentDidLoad(): void;
+    watchEnabled(): void;
+    private createFacetSlotIfAbsent;
+    /**
+     * This method is necessary to ensure that the facets slot is rendered outside of the component's shadow DOM, preserving
+     * correct CSS inheritance and slot behavior. If this logic were placed in the render
+     * function, the slot would be rendered inside the shadow DOM, which would break
+     * expected CSS styling and slot distribution.
+     */
+    private createFacetSlot;
+    private cloneFacets;
+    private addFacetColumnStyling;
+    private renderFilters;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-ipx-refine-modal': AtomicIpxRefineModal;
+    }
 }

package/dist/types/components/ipx/atomic-ipx-refine-toggle/atomic-ipx-refine-toggle.d.ts

@@ -1,14 +1,18 @@
-import { BreadcrumbManager, SearchStatus } from '@coveo/headless';
-import { Bindings } from '../../search/atomic-search-interface/atomic-search-interface';
+import { type BreadcrumbManager, type SearchStatus } from '@coveo/headless';
+import { LitElement } from 'lit';
+import type { Bindings } from "../../search/atomic-search-interface/atomic-search-interface";
+import type { InitializableComponent } from "../../../decorators/types";
+import "../atomic-ipx-refine-modal/atomic-ipx-refine-modal";
 /**
- * @internal
+ * The `atomic-ipx-refine-toggle` component displays a button that, when clicked, opens a refine modal containing facets.
+ *
+ * @part ipx-refine-toggle-container - The container div element.
+ * @part ipx-refine-toggle-button - The button element.
+ * @part ipx-refine-toggle-icon - The filter icon within the button.
+ * @part ipx-refine-toggle-badge - The badge element displaying the number of active filters.
  */
-export declare class AtomicIPXRefineToggle {
-    bindings: Bindings;
-    host: HTMLElement;
-    error: Error;
-    private breadcrumbManagerState;
-    private searchStatusState;
+export declare class AtomicIpxRefineToggle extends LitElement implements InitializableComponent<Bindings> {
+    static styles: import("lit").CSSResult;
     /**
      * The number of expanded facets inside the refine modal.
      * Remaining facets are automatically collapsed.
@@ -16,13 +20,24 @@ export declare class AtomicIPXRefineToggle {
      * Using the value `0` collapses all facets.
      */
     collapseFacetsAfter: number;
+    bindings: Bindings;
+    error: Error;
+    private breadcrumbManagerState;
     breadcrumbManager: BreadcrumbManager;
+    private searchStatusState;
     searchStatus: SearchStatus;
     private modalRef?;
     private buttonRef?;
+    private modalLoaded;
     private get numberOfBreadcrumbs();
     initialize(): void;
-    private enableModal;
     private loadModal;
-    render(): any;
+    private openModal;
+    private handleClick;
+    render(): typeof import("lit-html").nothing | import("lit-html").TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-ipx-refine-toggle': AtomicIpxRefineToggle;
+    }
 }

package/dist/types/components/ipx/index.d.ts

@@ -1,6 +1,9 @@
 export { AtomicIpxButton } from './atomic-ipx-button/atomic-ipx-button.js';
 export { AtomicIpxEmbedded } from './atomic-ipx-embedded/atomic-ipx-embedded.js';
 export { AtomicIpxModal } from './atomic-ipx-modal/atomic-ipx-modal.js';
+export { AtomicIpxRecsList } from './atomic-ipx-recs-list/atomic-ipx-recs-list.js';
+export { AtomicIpxRefineModal } from './atomic-ipx-refine-modal/atomic-ipx-refine-modal.js';
+export { AtomicIpxRefineToggle } from './atomic-ipx-refine-toggle/atomic-ipx-refine-toggle.js';
 export { AtomicIpxResultLink } from './atomic-ipx-result-link/atomic-ipx-result-link.js';
 export { AtomicIpxTab } from './atomic-ipx-tab/atomic-ipx-tab.js';
 export { AtomicIpxTabs } from './atomic-ipx-tabs/atomic-ipx-tabs.js';

package/dist/types/components/recommendations/atomic-recs-result/atomic-recs-result.d.ts

@@ -4,6 +4,7 @@ import type { DisplayConfig } from "../../common/item-list/context/item-display-
 import { type ItemRenderingFunction } from "../../common/item-list/item-list-common";
 import type { ItemDisplayDensity, ItemDisplayImageSize, ItemDisplayLayout } from "../../common/layout/item-layout-utils";
 import type { RecsStore } from "../atomic-recs-interface/store";
+import "../../search/atomic-result-link/atomic-result-link";
 declare const AtomicRecsResult_base: typeof LitElement;
 /**
  * The `atomic-recs-result` component is used internally by the `atomic-recs-list` component.

package/dist/types/components/search/atomic-external/atomic-external.d.ts

@@ -1,6 +1,6 @@
 import { LitElement } from 'lit';
 import type { AnyBindings } from "../../common/interface/bindings";
-import { type AtomicInterface } from "../../../utils/initialization-lit-stencil-common-utils";
+import { type AtomicInterface } from "../../../utils/initialization-common-utils";
 declare const AtomicExternal_base: typeof LitElement;
 /**
  * The `atomic-external` component allows components defined outside of the `atomic-search-interface` to initialize.

package/dist/types/components/search/atomic-generated-answer/atomic-generated-answer.d.ts

@@ -1,7 +1,8 @@
-import { type GeneratedAnswer, type SearchStatus, type TabManager, type TabManagerState } from '@coveo/headless';
+import { type GeneratedAnswer, type GeneratedAnswerWithFollowUps, type SearchStatus, type TabManager, type TabManagerState } from '@coveo/headless';
 import { LitElement, nothing, type PropertyValueMap } from 'lit';
 import type { Bindings } from "../atomic-search-interface/atomic-search-interface";
 import type { InitializableComponent } from "../../../decorators/types";
+import "../../common/generated-answer/atomic-generated-answers-thread/atomic-generated-answers-thread.js";
 /**
  * The `atomic-generated-answer` component uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user.
  * For more information, see [About Relevance Generative Answering (RGA)](https://docs.coveo.com/en/n9de0370/)
@@ -113,7 +114,7 @@ export declare class AtomicGeneratedAnswer extends LitElement implements Initial
     bindings: Bindings;
     error: Error;
     private generatedAnswerState;
-    generatedAnswer: GeneratedAnswer;
+    generatedAnswer: GeneratedAnswer | GeneratedAnswerWithFollowUps;
     private searchStatusState;
     searchStatus: SearchStatus;
     tabManagerState: TabManagerState;
@@ -147,7 +148,15 @@ export declare class AtomicGeneratedAnswer extends LitElement implements Initial
     private renderCitationsList;
     private renderFeedbackAndCopyButtonsWrapper;
     private renderAnswerContent;
+    private get hasAgentId();
+    private get generatedAnswerWithFollowUps();
+    private get areFollowUpsEnabled();
+    private get isCollapsibleEnabled();
+    private resetCollapsibleStyles;
     private renderCardHeaderWrapper;
+    private get isAnswerGenerationOngoing();
+    private handleAskFollowUp;
+    private renderAskFollowUpInputWrapper;
 }
 declare global {
     interface HTMLElementTagNameMap {

package/dist/types/components/search/atomic-refine-modal/atomic-refine-modal.d.ts

@@ -1,4 +1,4 @@
-import { type BreadcrumbManager, type FacetManager, type FacetManagerState, type QuerySummary, type QuerySummaryState, type SearchStatus, type Sort, type SortState, type TabManager, type TabManagerState } from '@coveo/headless';
+import { type BreadcrumbManager, type BreadcrumbManagerState, type FacetManager, type FacetManagerState, type QuerySummary, type QuerySummaryState, type SearchStatus, type Sort, type SortState, type TabManager, type TabManagerState } from '@coveo/headless';
 import { type CSSResultGroup, LitElement } from 'lit';
 import type { InitializableComponent } from "../../../decorators/types";
 import type { Bindings } from '../atomic-search-interface/atomic-search-interface';
@@ -6,7 +6,7 @@ import "../atomic-automatic-facet-generator/atomic-automatic-facet-generator";
 /**
  * The `atomic-refine-modal` component is automatically created as a child of the `atomic-search-interface` when the `atomic-refine-toggle` is initialized.
  *
- * When the modal is opened, the class `atomic-modal-opened` is added to the interface element and the body, allowing further customization.
+ * When the modal is opened, the class `atomic-modal-opened` is added to the interface element and the body.
  *
  * @part title - The title of the modal.
  * @part close-button - The button in the header that closes the modal.
@@ -33,6 +33,7 @@ import "../atomic-automatic-facet-generator/atomic-automatic-facet-generator";
  * @part header-wrapper - The wrapper around the header.
  * @part header - The header of the modal, containing the title.
  * @part container - The modal's outermost container.
+ * @part backdrop - The transparent backdrop hiding the content behind the modal.
  *
  * @cssprop --atomic-refine-modal-facet-margin - The margin between facets in the refine modal. Default is `20px`.
  */
@@ -58,7 +59,7 @@ export declare class AtomicRefineModal extends LitElement implements Initializab
     sort: Sort;
     sortState: SortState;
     breadcrumbManager: BreadcrumbManager;
-    private breadcrumbManagerState;
+    breadcrumbManagerState: BreadcrumbManagerState;
     querySummary: QuerySummary;
     querySummaryState: QuerySummaryState;
     searchStatus: SearchStatus;