@coveo/atomic 3.33.2-pre.f51bdbb034 → 3.33.3-pre.cff620d97c

package/dist/types/components/commerce/atomic-commerce-layout/atomic-commerce-layout.d.ts

@@ -5,15 +5,15 @@ declare const AtomicCommerceLayout_base: typeof LitElement;
  *
  * @cssprop --atomic-layout-max-search-box-input-width: The maximum width that the search box input will take.
  * @cssprop --atomic-layout-max-search-box-double-suggestions-width: The maximum width that the search box suggestions will take when displaying a double list.
- * @cssprop --atomic-layout-search-box-left-suggestions-width: When displaying a double list, the width of the left list.
+ * @cssprop --atomic-layout-search-box-left-suggestions-width: The width of the left list when displaying a double list.
  */
 export declare class AtomicCommerceLayout extends AtomicCommerceLayout_base {
     static styles: import("lit").CSSResult[];
     static dynamicStyles(instance: AtomicCommerceLayout): Promise<import("lit").CSSResult>;
     error: Error;
     /**
-     * CSS value that defines where the layout goes from mobile to desktop.
-     * e.g., 800px, 65rem.
+     * The viewport width at which the layout goes from desktop to mobile.
+     * E.g., 800px, 65rem.
      */
     mobileBreakpoint: string;
     connectedCallback(): void;

package/dist/types/components/commerce/atomic-commerce-recommendation-list/atomic-commerce-recommendation-list.d.ts

@@ -20,6 +20,9 @@ declare const AtomicCommerceRecommendationList_base: typeof LitElement;
  * @part active-indicator - The active indicator.
  *
  * @slot default - The default slot where the product templates are defined.
+ *
+ * @cssprop --atomic-recs-number-of-columns - The number of columns in the grid.
+ * @cssprop --atomic-recs-number-of-rows - The number of rows in the grid.
  */
 export declare class AtomicCommerceRecommendationList extends AtomicCommerceRecommendationList_base implements InitializableComponent<CommerceBindings> {
     static styles: CSSResultGroup;
@@ -52,7 +55,7 @@ export declare class AtomicCommerceRecommendationList extends AtomicCommerceReco
     productId?: string;
     /**
      * The layout to apply when displaying the products. This does not affect the display of the surrounding list itself.
-     * To modify the number of products per column, modify the `--atomic-recs-number-of-columns` CSS variable.
+     * To modify the number of products per column and row, modify the `--atomic-recs-number-of-columns` and `--atomic-recs-number-of-rows` CSS variables.
      */
     display: ItemDisplayBasicLayout;
     /**
@@ -72,6 +75,7 @@ export declare class AtomicCommerceRecommendationList extends AtomicCommerceReco
     productsPerPage?: number;
     /**
      * 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 an Heading Element.
      */
     headingLevel: number;
     watchNumberOfRecommendationsPerPage(): Promise<void>;

package/dist/types/components/commerce/atomic-commerce-text/atomic-commerce-text.d.ts

@@ -2,7 +2,6 @@ import { LitElement } from 'lit';
 import type { InitializableComponent } from "../../../decorators/types";
 import type { CommerceBindings } from '../atomic-commerce-interface/atomic-commerce-interface';
 /**
- * @alpha
  * The `atomic-commerce-text` component leverages the I18n translation module through the atomic-commerce-interface.
  */
 export declare class AtomicCommerceText extends LitElement implements InitializableComponent<CommerceBindings> {

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

@@ -1,6 +1,6 @@
 import { GeneratedAnswerCitation, InteractiveCitation } from '@coveo/headless';
 /**
- * @internal
+ * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
  */
 export declare class AtomicCitation {
     host: HTMLElement;

package/dist/types/components/common/generated-answer/atomic-generated-answer-feedback/atomic-generated-answer-feedback-modal.d.ts

@@ -3,7 +3,7 @@ import { EventEmitter } from '../../../../stencil-public-runtime';
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { AnyBindings } from '../../interface/bindings';
 /**
- * @internal
+ * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
  */
 export declare class AtomicGeneratedAnswerFeedbackModal implements InitializableComponent<AnyBindings> {
     bindings: AnyBindings;

package/dist/types/components/insight/atomic-insight-interface/atomic-insight-interface.d.ts

@@ -6,9 +6,6 @@ import { StencilBaseAtomicInterface } from '../../common/interface/interface-com
 import { InsightStore } from './store';
 export type InsightInitializationOptions = InsightEngineConfiguration;
 export type InsightBindings = CommonBindings<InsightEngine, InsightStore, HTMLAtomicInsightInterfaceElement> & NonceBindings;
-/**
- * @internal
- */
 export declare class AtomicInsightInterface implements StencilBaseAtomicInterface<InsightEngine> {
     private initialized;
     error?: Error;

package/dist/types/components/insight/user-actions/atomic-insight-user-actions-timeline/atomic-insight-user-actions-timeline.d.ts

@@ -2,7 +2,8 @@ import { UserActions as InsightUserActions, UserActionsState as InsightUserActio
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { InsightBindings } from '../../atomic-insight-interface/atomic-insight-interface';
 /**
- * @internal
+ * Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.
+ *
  * This component displays all the actions performed by a user around the time they created a case.
  * The actions are grouped into multiple sessions, including the session during which the case was created,
  * the sessions preceding the case creation and the sessions following the case creation.

package/dist/types/components/insight/user-actions/atomic-insight-user-actions-toggle/atomic-insight-user-actions-toggle.d.ts

@@ -2,7 +2,7 @@ import { UserActions as InsightUserActions, UserActionsState as InsightUserActio
 import { InitializableComponent } from '../../../../utils/initialization-utils';
 import { InsightBindings } from '../../atomic-insight-interface/atomic-insight-interface';
 /**
- * @internal
+ * Internal component of the atomic-insight-interface
  * The `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.
  */
 export declare class AtomicInsightUserActionsToggle implements InitializableComponent<InsightBindings> {

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

@@ -0,0 +1,26 @@
+import { LitElement } from 'lit';
+declare const AtomicSearchLayout_base: typeof LitElement;
+/**
+ * The `atomic-search-layout` helps organize elements in the page.
+ *
+ * @cssprop --atomic-layout-max-search-box-input-width: The maximum width that the search box input will take.
+ * @cssprop --atomic-layout-max-search-box-double-suggestions-width: The maximum width that the search box suggestions will take when displaying a double list.
+ * @cssprop --atomic-layout-search-box-left-suggestions-width: The width of the left list when displaying a double list.
+ */
+export declare class AtomicSearchLayout extends AtomicSearchLayout_base {
+    static styles: import("lit").CSSResult[];
+    static dynamicStyles(instance: AtomicSearchLayout): Promise<import("lit").CSSResult>;
+    error: Error;
+    /**
+     * The viewport width at which the layout goes from desktop to mobile.
+     * E.g., 800px, 65rem.
+     */
+    mobileBreakpoint: string;
+    connectedCallback(): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-search-layout': AtomicSearchLayout;
+    }
+}
+export {};

package/dist/types/components/search/atomic-search-layout/atomic-search-layout.tw.css.d.ts

@@ -0,0 +1,2 @@
+declare const styles: import("lit").CSSResult;
+export default styles;

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

@@ -1 +1,2 @@
 export { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
+export { AtomicSearchLayout } from './atomic-search-layout/atomic-search-layout.js';

package/dist/types/components.d.ts

@@ -166,6 +166,9 @@ export namespace Components {
          */
         "withSearch": boolean;
     }
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface AtomicCitation {
         /**
           * The citation item information.
@@ -568,6 +571,9 @@ export namespace Components {
          */
         "withToggle"?: boolean;
     }
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface AtomicGeneratedAnswerFeedbackModal {
         /**
           * A `GeneratedAnswer` controller instance. It is used when the user interacts with the modal.
@@ -1139,6 +1145,10 @@ export namespace Components {
         "userActions": Array<IUserAction>;
     }
     /**
+     * Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.
+     * This component displays all the actions performed by a user around the time they created a case.
+     * The actions are grouped into multiple sessions, including the session during which the case was created,
+     * the sessions preceding the case creation and the sessions following the case creation.
      * @component 
      * @example <AtomicInsightUserActionsTimeline userId={'123'} caseCreationDate={'2024-08-15T10:00:00Z'} />
      */
@@ -1156,6 +1166,10 @@ export namespace Components {
          */
         "userId": string;
     }
+    /**
+     * Internal component of the atomic-insight-interface
+     * The `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.
+     */
     interface AtomicInsightUserActionsToggle {
         /**
           * The names of custom events to exclude.
@@ -2536,15 +2550,6 @@ export namespace Components {
          */
         "timezone"?: string;
     }
-    /**
-     * The `atomic-search-layout` helps organize elements in the page.
-     */
-    interface AtomicSearchLayout {
-        /**
-          * CSS value that defines where the layout goes from mobile to desktop. e.g., 800px, 65rem.
-         */
-        "mobileBreakpoint": string;
-    }
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
      */
@@ -3045,6 +3050,9 @@ declare global {
         prototype: HTMLAtomicCategoryFacetElement;
         new (): HTMLAtomicCategoryFacetElement;
     };
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface HTMLAtomicCitationElement extends Components.AtomicCitation, HTMLStencilElement {
     }
     var HTMLAtomicCitationElement: {
@@ -3188,6 +3196,9 @@ declare global {
     interface HTMLAtomicGeneratedAnswerFeedbackModalElementEventMap {
         "feedbackSent": any;
     }
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface HTMLAtomicGeneratedAnswerFeedbackModalElement extends Components.AtomicGeneratedAnswerFeedbackModal, HTMLStencilElement {
         addEventListener<K extends keyof HTMLAtomicGeneratedAnswerFeedbackModalElementEventMap>(type: K, listener: (this: HTMLAtomicGeneratedAnswerFeedbackModalElement, ev: AtomicGeneratedAnswerFeedbackModalCustomEvent<HTMLAtomicGeneratedAnswerFeedbackModalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3467,6 +3478,10 @@ declare global {
         new (): HTMLAtomicInsightUserActionsSessionElement;
     };
     /**
+     * Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.
+     * This component displays all the actions performed by a user around the time they created a case.
+     * The actions are grouped into multiple sessions, including the session during which the case was created,
+     * the sessions preceding the case creation and the sessions following the case creation.
      * @component 
      * @example <AtomicInsightUserActionsTimeline userId={'123'} caseCreationDate={'2024-08-15T10:00:00Z'} />
      */
@@ -3476,6 +3491,10 @@ declare global {
         prototype: HTMLAtomicInsightUserActionsTimelineElement;
         new (): HTMLAtomicInsightUserActionsTimelineElement;
     };
+    /**
+     * Internal component of the atomic-insight-interface
+     * The `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.
+     */
     interface HTMLAtomicInsightUserActionsToggleElement extends Components.AtomicInsightUserActionsToggle, HTMLStencilElement {
     }
     var HTMLAtomicInsightUserActionsToggleElement: {
@@ -4258,15 +4277,6 @@ declare global {
         prototype: HTMLAtomicSearchInterfaceElement;
         new (): HTMLAtomicSearchInterfaceElement;
     };
-    /**
-     * The `atomic-search-layout` helps organize elements in the page.
-     */
-    interface HTMLAtomicSearchLayoutElement extends Components.AtomicSearchLayout, HTMLStencilElement {
-    }
-    var HTMLAtomicSearchLayoutElement: {
-        prototype: HTMLAtomicSearchLayoutElement;
-        new (): HTMLAtomicSearchLayoutElement;
-    };
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
      */
@@ -4666,7 +4676,6 @@ declare global {
         "atomic-search-box-query-suggestions": HTMLAtomicSearchBoxQuerySuggestionsElement;
         "atomic-search-box-recent-queries": HTMLAtomicSearchBoxRecentQueriesElement;
         "atomic-search-interface": HTMLAtomicSearchInterfaceElement;
-        "atomic-search-layout": HTMLAtomicSearchLayoutElement;
         "atomic-segmented-facet": HTMLAtomicSegmentedFacetElement;
         "atomic-segmented-facet-scrollable": HTMLAtomicSegmentedFacetScrollableElement;
         "atomic-smart-snippet": HTMLAtomicSmartSnippetElement;
@@ -4802,6 +4811,9 @@ declare namespace LocalJSX {
          */
         "withSearch"?: boolean;
     }
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface AtomicCitation {
         /**
           * The citation item information.
@@ -5201,6 +5213,9 @@ declare namespace LocalJSX {
          */
         "withToggle"?: boolean;
     }
+    /**
+     * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+     */
     interface AtomicGeneratedAnswerFeedbackModal {
         /**
           * A `GeneratedAnswer` controller instance. It is used when the user interacts with the modal.
@@ -5735,6 +5750,10 @@ declare namespace LocalJSX {
         "userActions": Array<IUserAction>;
     }
     /**
+     * Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.
+     * This component displays all the actions performed by a user around the time they created a case.
+     * The actions are grouped into multiple sessions, including the session during which the case was created,
+     * the sessions preceding the case creation and the sessions following the case creation.
      * @component 
      * @example <AtomicInsightUserActionsTimeline userId={'123'} caseCreationDate={'2024-08-15T10:00:00Z'} />
      */
@@ -5752,6 +5771,10 @@ declare namespace LocalJSX {
          */
         "userId": string;
     }
+    /**
+     * Internal component of the atomic-insight-interface
+     * The `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.
+     */
     interface AtomicInsightUserActionsToggle {
         /**
           * The names of custom events to exclude.
@@ -7041,15 +7064,6 @@ declare namespace LocalJSX {
          */
         "timezone"?: string;
     }
-    /**
-     * The `atomic-search-layout` helps organize elements in the page.
-     */
-    interface AtomicSearchLayout {
-        /**
-          * CSS value that defines where the layout goes from mobile to desktop. e.g., 800px, 65rem.
-         */
-        "mobileBreakpoint"?: string;
-    }
     /**
      * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
      */
@@ -7560,7 +7574,6 @@ declare namespace LocalJSX {
         "atomic-search-box-query-suggestions": AtomicSearchBoxQuerySuggestions;
         "atomic-search-box-recent-queries": AtomicSearchBoxRecentQueries;
         "atomic-search-interface": AtomicSearchInterface;
-        "atomic-search-layout": AtomicSearchLayout;
         "atomic-segmented-facet": AtomicSegmentedFacet;
         "atomic-segmented-facet-scrollable": AtomicSegmentedFacetScrollable;
         "atomic-smart-snippet": AtomicSmartSnippet;
@@ -7616,6 +7629,9 @@ declare module "@stencil/core" {
              * An `atomic-category-facet` displays a facet of values in a browsable, hierarchical fashion.
              */
             "atomic-category-facet": LocalJSX.AtomicCategoryFacet & JSXBase.HTMLAttributes<HTMLAtomicCategoryFacetElement>;
+            /**
+             * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+             */
             "atomic-citation": LocalJSX.AtomicCitation & JSXBase.HTMLAttributes<HTMLAtomicCitationElement>;
             /**
              * A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
@@ -7675,6 +7691,9 @@ declare module "@stencil/core" {
              * For more information, see [About Relevance Generative Answering (RGA)](https://docs.coveo.com/en/n9de0370/)
              */
             "atomic-generated-answer": LocalJSX.AtomicGeneratedAnswer & JSXBase.HTMLAttributes<HTMLAtomicGeneratedAnswerElement>;
+            /**
+             * Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`
+             */
             "atomic-generated-answer-feedback-modal": LocalJSX.AtomicGeneratedAnswerFeedbackModal & JSXBase.HTMLAttributes<HTMLAtomicGeneratedAnswerFeedbackModalElement>;
             /**
              * The `atomic-html` component renders the HTML value of a string.
@@ -7721,10 +7740,18 @@ declare module "@stencil/core" {
              */
             "atomic-insight-user-actions-session": LocalJSX.AtomicInsightUserActionsSession & JSXBase.HTMLAttributes<HTMLAtomicInsightUserActionsSessionElement>;
             /**
+             * Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.
+             * This component displays all the actions performed by a user around the time they created a case.
+             * The actions are grouped into multiple sessions, including the session during which the case was created,
+             * the sessions preceding the case creation and the sessions following the case creation.
              * @component 
              * @example <AtomicInsightUserActionsTimeline userId={'123'} caseCreationDate={'2024-08-15T10:00:00Z'} />
              */
             "atomic-insight-user-actions-timeline": LocalJSX.AtomicInsightUserActionsTimeline & JSXBase.HTMLAttributes<HTMLAtomicInsightUserActionsTimelineElement>;
+            /**
+             * Internal component of the atomic-insight-interface
+             * The `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.
+             */
             "atomic-insight-user-actions-toggle": LocalJSX.AtomicInsightUserActionsToggle & JSXBase.HTMLAttributes<HTMLAtomicInsightUserActionsToggleElement>;
             "atomic-ipx-body": LocalJSX.AtomicIpxBody & JSXBase.HTMLAttributes<HTMLAtomicIpxBodyElement>;
             "atomic-ipx-button": LocalJSX.AtomicIpxButton & JSXBase.HTMLAttributes<HTMLAtomicIpxButtonElement>;
@@ -8078,10 +8105,6 @@ declare module "@stencil/core" {
              * The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
              */
             "atomic-search-interface": LocalJSX.AtomicSearchInterface & JSXBase.HTMLAttributes<HTMLAtomicSearchInterfaceElement>;
-            /**
-             * The `atomic-search-layout` helps organize elements in the page.
-             */
-            "atomic-search-layout": LocalJSX.AtomicSearchLayout & JSXBase.HTMLAttributes<HTMLAtomicSearchLayoutElement>;
             /**
              * The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.
              */