@coveo/atomic 3.32.4-pre.fa85bf855f → 3.32.4-pre.fbe3129c94

package/dist/types/components.d.ts

@@ -1139,6 +1139,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 +1160,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.
@@ -3467,6 +3475,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 +3488,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: {
@@ -5735,6 +5751,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 +5772,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.
@@ -7721,10 +7745,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>;

package/dist/types/mixins/commerce-layout-mixin.d.ts

@@ -0,0 +1,18 @@
+import { type CSSResult, type LitElement } from 'lit';
+import type { Constructor } from './mixin-common';
+export interface CommerceLayoutRequirements {
+    error: Error;
+    mobileBreakpoint: string;
+}
+/**
+ *
+ * @param superClass The class to extend, typically a LitElement.
+ * @param cssResult The CSSResult to inject into the component styles.
+ * @returns A new class that extends the provided superClass with the commerce layout mixin.
+ *
+ * @remarks
+ * Any Lit component using this mixin MUST declare the following public properties:
+ * - `error: Error`
+ * - `mobileBreakpoint: string`
+ */
+export declare const CommerceLayoutMixin: <T extends Constructor<LitElement>>(superClass: T, cssResult: CSSResult) => T;