@coveo/atomic 3.51.0 → 3.52.1

package/dist/types/components/common/generated-answer/atomic-generated-answers-thread/atomic-generated-answers-thread.d.ts

@@ -0,0 +1,42 @@
+import type { GeneratedAnswerCitation } from '@coveo/headless';
+import { LitElement, type nothing, type PropertyValues, type TemplateResult } from 'lit';
+import "../atomic-generated-answer-thread-item/atomic-generated-answer-thread-item";
+import "../atomic-answer-content/atomic-answer-content";
+import type { i18n } from 'i18next';
+import type { GeneratedAnswer } from "../atomic-answer-content/atomic-answer-content";
+/**
+ * The `atomic-generated-answers-thread` component is responsible for rendering a thread of generated answers.
+ * @internal
+ */
+export declare class AtomicGeneratedAnswersThread extends LitElement {
+    /**
+     * The list of generated answers to render in the thread.
+     */
+    generatedAnswers: GeneratedAnswer[];
+    /**
+     * The i18next instance used to translate UI labels.
+     */
+    i18n: i18n;
+    /**
+     * A render function responsible for displaying the citations of a single answer.
+     */
+    renderCitations: (citations: GeneratedAnswerCitation[]) => TemplateResult | typeof nothing;
+    /**
+     * Callback invoked when the user clicks the "like" feedback button of a specific answer.
+     */
+    onClickLike: (answerId: string) => void;
+    /**
+     * Callback invoked when the user clicks the "dislike" feedback button of a specific answer.
+     */
+    onClickDislike: (answerId: string) => void;
+    /**
+     * Callback invoked after the text of a specific answer has been successfully copied.
+     */
+    onCopyToClipboard: (answerId: string) => void;
+    private allGeneratedAnswersDisplayed;
+    updated(changedProperties: PropertyValues<this>): void;
+    render(): TemplateResult<1>;
+    private renderThread;
+    private handleShowAllClick;
+    private renderShowPreviousAnswersButton;
+}

package/dist/types/components/common/generated-answer/render-agent-generation-steps.d.ts

@@ -0,0 +1,16 @@
+import type { GenerationStep } from '@coveo/headless';
+import type { i18n } from 'i18next';
+import type { FunctionalComponent } from "../../../utils/functional-component-utils";
+export interface RenderAgentGenerationStepsProps {
+    i18n: i18n;
+    agentSteps: GenerationStep[];
+    isStreaming: boolean;
+}
+/**
+ * @internal
+ */
+export declare const renderAgentGenerationSteps: FunctionalComponent<RenderAgentGenerationStepsProps>;
+/**
+ * Returns the current generation-step localization key.
+ */
+export declare function getCurrentStepKey(generationSteps: GenerationStep[]): string | undefined;

package/dist/types/components/common/generated-answer/render-answer-content.d.ts

@@ -4,10 +4,9 @@ import type { TemplateResult } from 'lit';
 import { nothing } from 'lit';
 import type { FunctionalComponent } from "../../../utils/functional-component-utils";
 import "../atomic-icon/atomic-icon";
-interface GeneratedAnswer extends GeneratedAnswerBase {
-    question: string;
+type GeneratedAnswer = GeneratedAnswerBase & {
     expanded?: boolean;
-}
+};
 export interface RenderAnswerContentProps {
     i18n: i18n;
     generatedAnswer: GeneratedAnswer;
@@ -18,7 +17,7 @@ export interface RenderAnswerContentProps {
     onClickShowButton: () => void;
 }
 /**
- * Renders the answer content of a given generated answer including question, answer text, and citations.
+ * Renders the answer content of a given generated answer including answer text and citations.
  */
 export declare const renderAnswerContent: FunctionalComponent<RenderAnswerContentProps>;
 export {};

package/dist/types/components/insight/atomic-insight-result-action/atomic-insight-result-action.d.ts

@@ -1,6 +1,7 @@
-import { Result } from '@coveo/headless';
-import { InitializableComponent } from '../../../utils/initialization-utils';
-import { InsightBindings } from '../atomic-insight-interface/atomic-insight-interface';
+import type { Result } from '@coveo/headless';
+import { LitElement } from 'lit';
+import type { InsightBindings } from "../atomic-insight-interface/atomic-insight-interface";
+import type { InitializableComponent } from "../../../decorators/types";
 export interface InsightResultActionClickedEvent {
     action: string;
     result: Result;
@@ -12,22 +13,21 @@ export declare enum Actions {
     PostToFeed = "postToFeed",
     SendAsEmail = "sendAsEmail"
 }
+declare const AtomicInsightResultAction_base: import("../../../mixins/mixin-common").Constructor<{
+    injectStyles(dynamicStyles?: import("lit").CSSResultGroup): Promise<void>;
+}> & typeof LitElement;
 /**
- * @internal
+ * The `atomic-insight-result-action` component renders an interactive action button for insight results.
+ *
+ * @part result-action-container - The result action container
+ * @part result-action-button - The result action button
+ * @part result-action-icon - The result action icon
+ * @event atomicInsightResultActionClicked - Fired when the action button is clicked. The event detail contains the action type and the result object.
  */
-export declare class AtomicInsightResultAction implements InitializableComponent<InsightBindings> {
-    bindings: InsightBindings;
-    private result;
-    error: Error;
-    /**
-     * @migration Stencil's @Event() decorator defaults to: bubbles=true, composed=true, cancelable=true.
-     * Native CustomEvent defaults to: bubbles=false, composed=false, cancelable=false.
-     * When migrating to Lit, explicitly set all three options to preserve behavior:
-     * `new CustomEvent('atomicInsightResultActionClicked', { bubbles: true, composed: true, cancelable: true, detail: ... })`
-     */
-    private actionClicked;
+export declare class AtomicInsightResultAction extends AtomicInsightResultAction_base implements InitializableComponent<InsightBindings> {
+    static styles: import("lit").CSSResult;
     /**
-     * Specify the result action icon to display.
+     * The result action icon to display.
      */
     icon: string;
     /**
@@ -39,12 +39,27 @@ export declare class AtomicInsightResultAction implements InitializableComponent
      */
     tooltipOnClick: string;
     /**
-     * The type of action to perform when the result action is clicked. This will be sent along the event fired when the button is clicked.
+     * The type of action to perform when the result action is clicked.
+     * This will be sent along the event fired when the button is clicked.
      */
     action: Actions | string;
+    bindings: InsightBindings;
+    error: Error;
+    private currentTooltip;
+    private itemContextController;
     private actions;
+    private tooltipResetTimeout?;
+    constructor();
+    disconnectedCallback(): void;
+    private get result();
     initialize(): void;
     private onClick;
     private getIcon;
-    render(): any;
+    render(): typeof import("lit-html").nothing | import("lit-html").TemplateResult | null;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-insight-result-action': AtomicInsightResultAction;
+    }
 }
+export {};

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

@@ -3,6 +3,7 @@ import type { ItemDisplayImageSize } from "../../common/layout/item-layout-utils
 import type { InsightBindings } from "../atomic-insight-interface/atomic-insight-interface";
 import type { InitializableComponent } from "../../../decorators/types";
 import "../atomic-insight-result/atomic-insight-result";
+import "../atomic-insight-result-children-template/atomic-insight-result-children-template";
 /**
  * The `atomic-insight-result-children` component is responsible for displaying child results by applying one or more child result templates.
  * It includes two slots, `before-children` and `after-children`, which allow for rendering content before and after the list of children,

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

@@ -0,0 +1,62 @@
+import type { ResultTemplate as InsightResultTemplate, ResultTemplateCondition as InsightResultTemplateCondition } from '@coveo/headless/insight';
+import { LitElement } from 'lit';
+import type { LitElementWithError } from "../../../decorators/types";
+/**
+ * The `atomic-insight-result-children-template` component determines the display format of child results within an `atomic-insight-result-children` component.
+ *
+ * @slot default - The `<template>` element defining the layout of child results.
+ */
+export declare class AtomicInsightResultChildrenTemplate extends LitElement implements LitElementWithError {
+    error: Error;
+    /**
+     * An array of functions that must each return `true` for this template to apply to a child result.
+     * Set programmatically before initialization, not via attribute.
+     *
+     * For example, the following targets a template and sets a condition to make it apply only to child results whose `title` contains `singapore`:
+     * `document.querySelector('#target-template').conditions = [(result) => /singapore/i.test(result.title)];`
+     */
+    conditions: InsightResultTemplateCondition[];
+    /**
+     * The field that, when defined on a child result, allows this template to be applied.
+     *
+     * For example, a template with the following attribute only applies to child results whose `filetype` and `sourcetype` fields are defined:
+     * `if-defined="filetype,sourcetype"`
+     */
+    ifDefined?: string;
+    /**
+     * The field that, when defined on a child result, prevents this template from being applied.
+     *
+     * For example, a template with the following attribute only applies to child results whose `filetype` and `sourcetype` fields are NOT defined:
+     * `if-not-defined="filetype,sourcetype"`
+     */
+    ifNotDefined?: string;
+    /**
+     * The field and values that define which child results this template applies to.
+     *
+     * For example, a template with the following attribute only applies to child results whose `filetype` is `lithiummessage` or `YouTubePlaylist`: `must-match-filetype="lithiummessage,YouTubePlaylist"`
+     * @type {Record<string, string[]>}
+     * @default {}
+     */
+    mustMatch: Record<string, string[]>;
+    /**
+     * The field and values that exclude child results from this template.
+     *
+     * For example, a template with the following attribute only applies to child results whose `filetype` is not `lithiummessage`: `must-not-match-filetype="lithiummessage"`
+     * @type {Record<string, string[]>}
+     * @default {}
+     */
+    mustNotMatch: Record<string, string[]>;
+    private resultTemplateController;
+    constructor();
+    connectedCallback(): void;
+    render(): symbol;
+    /**
+     * Returns the result template to apply to a child result, based on all defined conditions.
+     */
+    getTemplate(): Promise<InsightResultTemplate<DocumentFragment> | null>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-insight-result-children-template': AtomicInsightResultChildrenTemplate;
+    }
+}

package/dist/types/components/insight/atomic-insight-timeframe-facet/atomic-insight-timeframe-facet.d.ts

@@ -1,26 +1,31 @@
-import { DateFacet as InsightDateFacet, DateFacetState as InsightDateFacetState, DateFilter as InsightDateFilter, DateFilterState as InsightDateFilterState, SearchStatus as InsightSearchStatus, SearchStatusState as InsightSearchStatusState, RangeFacetSortCriterion as InsightRangeFacetSortCriterion } from '@coveo/headless/insight';
-import { InitializableComponent } from '../../../utils/initialization-utils';
-import { InsightBindings } from '../atomic-insight-interface/atomic-insight-interface';
+import { type RangeFacetSortCriterion, type SearchStatus, type SearchStatusState } from '@coveo/headless/insight';
+import { type CSSResultGroup, LitElement } from 'lit';
+import type { InsightBindings } from "../atomic-insight-interface/atomic-insight-interface";
+import type { InitializableComponent } from "../../../decorators/types";
 /**
- * @internal
+ * The `atomic-insight-timeframe-facet` component displays a facet of results for the current query as date intervals.
+ *
+ * @slot default - The atomic-timeframe components defining the timeframes to display.
+ *
+ * @part facet - The wrapper for the entire facet.
+ * @part placeholder - The placeholder shown before the first search is executed.
+ * @part label-button - The button that displays the label and allows to expand/collapse the facet.
+ * @part label-button-icon - The label button icon.
+ * @part clear-button - The button that resets the actively selected facet values.
+ * @part clear-button-icon - The clear button icon.
+ * @part values - The facet values container.
+ * @part value-link - A facet value button.
+ * @part value-link-selected - A selected facet value button.
+ * @part value-count - The result count for a facet value.
+ * @part value-label - The label text of a facet value.
+ * @part input-start - The starting value of the custom date range.
+ * @part input-end - The ending value of the custom date range.
+ * @part input-label - The label for both the start and end input.
+ * @part input-apply-button - The apply button for the custom range.
  */
-export declare class AtomicInsightTimeframeFacet implements InitializableComponent<InsightBindings> {
-    bindings: InsightBindings;
-    facetForDateRange?: InsightDateFacet;
-    facetForDatePicker?: InsightDateFacet;
-    private timeframeFacetCommon?;
-    filter?: InsightDateFilter;
-    searchStatus: InsightSearchStatus;
-    private host;
-    facetState: InsightDateFacetState;
-    facetForDatePickerState?: InsightDateFacetState;
-    filterState?: InsightDateFilterState;
-    searchStatusState: InsightSearchStatusState;
-    error: Error;
-    /**
-     * Specifies a unique identifier for the facet.
-     */
-    facetId?: string;
+export declare class AtomicInsightTimeframeFacet extends LitElement implements InitializableComponent<InsightBindings> {
+    private static readonly propsSchema;
+    static styles: CSSResultGroup;
     /**
      * The non-localized label for the facet.
      * Used in the atomic-breadbox component through the bindings store.
@@ -31,11 +36,11 @@ export declare class AtomicInsightTimeframeFacet implements InitializableCompone
      */
     field: string;
     /**
-     * Whether this facet should contain a date picker allowing users to set custom ranges.
+     * Whether this facet should contain a datepicker allowing users to set custom ranges.
      */
     withDatePicker: boolean;
     /**
-     * Specifies if the facet is collapsed.
+     * Specifies whether the facet is collapsed. When the facet is the child of an `atomic-facet-manager` component, the facet manager controls this property.
      */
     isCollapsed: boolean;
     /**
@@ -45,7 +50,6 @@ export declare class AtomicInsightTimeframeFacet implements InitializableCompone
     /**
      * Whether to exclude the parents of folded results when estimating the result count for each facet value.
      *
-     *
      * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
      */
     filterFacetCount: boolean;
@@ -80,14 +84,29 @@ export declare class AtomicInsightTimeframeFacet implements InitializableCompone
      * The sort criterion to apply to the returned facet values.
      * Possible values are 'ascending' and 'descending'.
      */
-    sortCriteria: InsightRangeFacetSortCriterion;
+    sortCriteria: RangeFacetSortCriterion;
+    /**
+     * Specifies a unique identifier for the facet.
+     */
+    facetId?: string;
+    bindings: InsightBindings;
+    error: Error;
+    searchStatusState: SearchStatusState;
+    searchStatus: SearchStatus;
     private headerFocus?;
-    initialize(): void;
+    private timeframeFacetCommon?;
+    constructor();
     private get focusTarget();
+    initialize(): void;
     disconnectedCallback(): void;
     private initializeFacetForDatePicker;
     private initializeFacetForDateRange;
     private initializeFilter;
-    applyDateInput(): void;
-    render(): any;
+    private handleDateInputApply;
+    protected render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-insight-timeframe-facet': AtomicInsightTimeframeFacet;
+    }
 }

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

@@ -15,10 +15,12 @@ export { AtomicInsightQuerySummary } from './atomic-insight-query-summary/atomic
 export { AtomicInsightRefineModal } from './atomic-insight-refine-modal/atomic-insight-refine-modal.js';
 export { AtomicInsightRefineToggle } from './atomic-insight-refine-toggle/atomic-insight-refine-toggle.js';
 export { AtomicInsightResult } from './atomic-insight-result/atomic-insight-result.js';
+export { AtomicInsightResultAction } from './atomic-insight-result-action/atomic-insight-result-action.js';
 export { AtomicInsightResultActionBar } from './atomic-insight-result-action-bar/atomic-insight-result-action-bar.js';
 export { AtomicInsightResultAttachToCaseAction } from './atomic-insight-result-attach-to-case-action/atomic-insight-result-attach-to-case-action.js';
 export { AtomicInsightResultAttachToCaseIndicator } from './atomic-insight-result-attach-to-case-indicator/atomic-insight-result-attach-to-case-indicator.js';
 export { AtomicInsightResultChildren } from './atomic-insight-result-children/atomic-insight-result-children.js';
+export { AtomicInsightResultChildrenTemplate } from './atomic-insight-result-children-template/atomic-insight-result-children-template.js';
 export { AtomicInsightResultList } from './atomic-insight-result-list/atomic-insight-result-list.js';
 export { AtomicInsightResultQuickviewAction } from './atomic-insight-result-quickview-action/atomic-insight-result-quickview-action.js';
 export { AtomicInsightResultTemplate } from './atomic-insight-result-template/atomic-insight-result-template.js';
@@ -28,6 +30,7 @@ export { AtomicInsightSmartSnippetFeedbackModal } from './atomic-insight-smart-s
 export { AtomicInsightSmartSnippetSuggestions } from './atomic-insight-smart-snippet-suggestions/atomic-insight-smart-snippet-suggestions.js';
 export { AtomicInsightTab } from './atomic-insight-tab/atomic-insight-tab.js';
 export { AtomicInsightTabs } from './atomic-insight-tabs/atomic-insight-tabs.js';
+export { AtomicInsightTimeframeFacet } from './atomic-insight-timeframe-facet/atomic-insight-timeframe-facet.js';
 export { AtomicInsightUserActionsModal } from './atomic-insight-user-actions-modal/atomic-insight-user-actions-modal.js';
 export { AtomicInsightUserActionsSession } from './atomic-insight-user-actions-session/atomic-insight-user-actions-session.js';
 export { AtomicInsightUserActionsTimeline } from './atomic-insight-user-actions-timeline/atomic-insight-user-actions-timeline.js';

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 {