@coveo/atomic 3.35.0-pre.678b20e0ef → 3.35.0-pre.764984a52c

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

@@ -1,17 +1,21 @@
-import { FoldedResult, InteractiveResult, Result } from '@coveo/headless';
-import { DisplayConfig } from '../../common/item-list/stencil-item-decorators';
-import { ItemRenderingFunction } from '../../common/item-list/stencil-item-list-common';
-import { ItemDisplayDensity, ItemDisplayImageSize, ItemDisplayLayout } from '../../common/layout/display-options';
-import { SearchStore } from '../atomic-search-interface/store';
-import { InteractiveResultContextEvent, ResultContextEvent } from "../result-template-component-utils/context/stencil-result-template-decorators";
+import type { FoldedResult, InteractiveResult, Result } from '@coveo/headless';
+import { type CSSResultGroup, LitElement } from 'lit';
+import type { DisplayConfig } from "../../common/item-list/context/item-display-config-context-controller";
+import { type ItemRenderingFunction } from "../../common/item-list/item-list-common";
+import type { ItemDisplayDensity, ItemDisplayImageSize, ItemDisplayLayout } from "../../common/layout/display-options";
+import type { SearchStore } from "../atomic-search-interface/store";
+import type { InteractiveResultContextEvent, ResultContextEvent } from "../result-template-component-utils/context/result-context-controller";
+declare const AtomicResult_base: typeof LitElement;
 /**
- * The `atomic-result` component is used internally by the `atomic-result-list` component.
+ * The `atomic-result` component is used internally by the `atomic-result-list` and `atomic-folded-result-list` components.
  */
-export declare class AtomicResult {
-    private layout;
-    host: HTMLElement;
+export declare class AtomicResult extends AtomicResult_base {
+    private resultRootRef?;
+    private linkContainerRef?;
+    private itemLayoutController;
+    static styles: CSSResultGroup;
     /**
-     * Whether an atomic-result-link inside atomic-result should stop click event propagation.
+     * Whether `atomic-result-link` components nested in the `atomic-result` should stop click event propagation.
      */
     stopPropagation?: boolean;
     /**
@@ -20,12 +24,10 @@ export declare class AtomicResult {
     result: Result | FoldedResult;
     /**
      * The InteractiveResult item.
-     * @internal
      */
     interactiveResult: InteractiveResult;
     /**
      * Global Atomic state.
-     * @internal
      */
     store?: SearchStore;
     /**
@@ -57,30 +59,37 @@ export declare class AtomicResult {
      */
     classes: string;
     /**
+     * A unique identifier for tracking the loading state of this result component.
+     * When set, this flag is added to the global loading flags array and automatically
+     * removed when the component finishes its initial render. This allows the framework
+     * to determine when all components have finished loading.
+     *
      * @internal
      */
     loadingFlag?: string;
     /**
-     * Internal function used by atomic-recs-list in advanced setups, which lets you bypass the standard HTML template system.
-     * Particularly useful for Atomic React
+     * Internal function used in advanced setups, which lets you bypass the standard HTML template system.
+     * Particularly useful for Atomic React.
      *
      * @internal
      */
     renderingFunction: ItemRenderingFunction;
-    private resultRootRef?;
-    private linkContainerRef?;
-    private executedRenderingFunctionOnce;
-    resolveResult(event: ResultContextEvent<FoldedResult | Result>): void;
-    resolveInteractiveResult(event: InteractiveResultContextEvent): void;
-    resolveStopPropagation(event: CustomEvent): void;
-    resolveResultDisplayConfig(event: ResultContextEvent<DisplayConfig>): void;
-    handleClick(event: MouseEvent): void;
-    connectedCallback(): void;
-    private get isCustomRenderFunctionMode();
+    resolveResult: (event: ResultContextEvent) => void;
+    resolveInteractiveResult: (event: InteractiveResultContextEvent) => void;
+    resolveStopPropagation: (event: CustomEvent) => void;
+    resolveResultDisplayConfig: (event: ResultContextEvent<DisplayConfig>) => void;
+    handleClick: (event: MouseEvent) => void;
+    clickLinkContainer: () => void;
+    connectedCallback(): Promise<void>;
+    disconnectedCallback(): void;
     private getContentHTML;
     private getLinkHTML;
-    private shouldExecuteRenderFunction;
-    render(): any;
-    componentDidLoad(): void;
-    componentDidRender(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    firstUpdated(_changedProperties: Map<string, unknown>): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result': AtomicResult;
+    }
 }
+export {};

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

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

package/dist/types/components/search/{result-template-components/atomic-result-sections → atomic-result-section-actions}/atomic-result-section-actions.d.ts

@@ -1,3 +1,5 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionActions_base: typeof LitElement;
 /**
  * This section allows the information seeker to perform an action on an item without having to view its details.
  * For example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.
@@ -8,7 +10,11 @@
  * * Is a wrapping flexbox with a gap.
  * * May appear over, next to, or beneath the visual section.
  */
-export declare class AtomicResultSectionActions {
-    private host;
-    componentDidRender(): void;
+export declare class AtomicResultSectionActions extends AtomicResultSectionActions_base {
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-actions': AtomicResultSectionActions;
+    }
+}
+export {};

package/dist/types/components/search/{result-template-components/atomic-result-sections → atomic-result-section-badges}/atomic-result-section-badges.d.ts

@@ -1,3 +1,5 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionBadges_base: typeof LitElement;
 /**
  * This section provides badges that highlight special features of the item.
  *
@@ -7,7 +9,11 @@
  * * Is a wrapping flexbox with a gap.
  * * May appear over, next to, or beneath the visual section.
  */
-export declare class AtomicResultSectionBadges {
-    private host;
-    componentDidRender(): void;
+export declare class AtomicResultSectionBadges extends AtomicResultSectionBadges_base {
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-badges': AtomicResultSectionBadges;
+    }
+}
+export {};

package/dist/types/components/search/{result-template-components/atomic-result-sections → atomic-result-section-bottom-metadata}/atomic-result-section-bottom-metadata.d.ts

@@ -1,3 +1,5 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionBottomMetadata_base: typeof LitElement;
 /**
  * This section displays additional descriptive information about the item.
  *
@@ -8,7 +10,11 @@
  * * Has a defined CSS `color` property for text.
  * * Has a font weight.
  */
-export declare class AtomicResultSectionBottomMetadata {
-    private host;
-    componentDidRender(): void;
+export declare class AtomicResultSectionBottomMetadata extends AtomicResultSectionBottomMetadata_base {
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-bottom-metadata': AtomicResultSectionBottomMetadata;
+    }
+}
+export {};

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

@@ -0,0 +1,16 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionChildren_base: typeof LitElement;
+/**
+ * This section displays the folded results, available when using the <atomic-result-children> component.
+ *
+ * Behavior:
+ * * Shows children at the bottom of the result, indented and wrapped in a border.
+ */
+export declare class AtomicResultSectionChildren extends AtomicResultSectionChildren_base {
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-children': AtomicResultSectionChildren;
+    }
+}
+export {};

package/dist/types/components/search/atomic-result-section-emphasized/atomic-result-section-emphasized.d.ts

@@ -0,0 +1,18 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionEmphasized_base: typeof LitElement;
+/**
+ * This section displays the field that's important for its search criteria.
+ * For example, in Commerce, a product's cost is often more important than the title itself.
+ *
+ * Behavior:
+ * * Has a very large font size.
+ * * Is the second closest element beneath the title section.
+ */
+export declare class AtomicResultSectionEmphasized extends AtomicResultSectionEmphasized_base {
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-emphasized': AtomicResultSectionEmphasized;
+    }
+}
+export {};

package/dist/types/components/search/{result-template-components/atomic-result-sections → atomic-result-section-excerpt}/atomic-result-section-excerpt.d.ts

@@ -1,3 +1,5 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionExcerpt_base: typeof LitElement;
 /**
  * This section contains an informative summary of the item's content.
  *
@@ -7,7 +9,11 @@
  * * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
  * * Has a defined CSS `color` property for text.
  */
-export declare class AtomicResultSectionExcerpt {
-    private host;
-    componentDidRender(): void;
+export declare class AtomicResultSectionExcerpt extends AtomicResultSectionExcerpt_base {
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-excerpt': AtomicResultSectionExcerpt;
+    }
+}
+export {};

package/dist/types/components/search/{result-template-components/atomic-result-sections → atomic-result-section-title}/atomic-result-section-title.d.ts

@@ -1,3 +1,5 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionTitle_base: typeof LitElement;
 /**
  * This section identifies the item by its name, and its main use is to make the result list scannable.
  * This is usually the page title.
@@ -7,7 +9,11 @@
  * * Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.
  * * Has a defined CSS `color` property for text.
  */
-export declare class AtomicResultSectionTitle {
-    private host;
-    componentDidRender(): void;
+export declare class AtomicResultSectionTitle extends AtomicResultSectionTitle_base {
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-title': AtomicResultSectionTitle;
+    }
+}
+export {};

package/dist/types/components/search/atomic-result-section-title-metadata/atomic-result-section-title-metadata.d.ts

@@ -0,0 +1,19 @@
+import { LitElement } from 'lit';
+declare const AtomicResultSectionTitleMetadata_base: typeof LitElement;
+/**
+ * This section surfaces some fields that are directly related to the title of the item.
+ * For example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,
+ * rather than to the product's description.
+ *
+ * Behavior:
+ * * Has a very small font size.
+ * * Is the closest element beneath the title section.
+ */
+export declare class AtomicResultSectionTitleMetadata extends AtomicResultSectionTitleMetadata_base {
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-title-metadata': AtomicResultSectionTitleMetadata;
+    }
+}
+export {};

package/dist/types/components/search/atomic-result-section-visual/atomic-result-section-visual.d.ts

@@ -0,0 +1,26 @@
+import { LitElement } from 'lit';
+import type { ItemDisplayImageSize } from "../../common/layout/display-options";
+declare const AtomicResultSectionVisual_base: typeof LitElement;
+/**
+ * This section provides visual information about the item.
+ * For example, in Commerce, an image is a great shorthand for a result category.
+ * An icon can quickly show the item type, or an avatar can help identify to whom it is related.
+ *
+ * Behavior:
+ * * Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.
+ * ** When the image size is set to `icon`, this section stays very small.
+ * ** You should ensure that elements inside of it take the available space.
+ * * Always has a 1:1 aspect ratio.
+ */
+export declare class AtomicResultSectionVisual extends AtomicResultSectionVisual_base {
+    /**
+     * How large or small the visual section of result using this template should be.
+     */
+    imageSize?: Omit<ItemDisplayImageSize, 'icon'>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-section-visual': AtomicResultSectionVisual;
+    }
+}
+export {};

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

@@ -6,6 +6,7 @@ import { type BaseAtomicInterface } from "../../common/interface/interface-contr
 import "../atomic-relevance-inspector/atomic-relevance-inspector";
 import { type SearchStore } from './store';
 import "../../common/atomic-modal/atomic-modal";
+import '../atomic-result/atomic-result';
 export type InitializationOptions = SearchEngineConfiguration;
 export type Bindings = CommonBindings<SearchEngine, SearchStore, AtomicSearchInterface> & NonceBindings;
 declare const AtomicSearchInterface_base: typeof LitElement;

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

@@ -1,6 +1,16 @@
 export { AtomicPager } from './atomic-pager/atomic-pager.js';
 export { AtomicQuerySummary } from './atomic-query-summary/atomic-query-summary.js';
 export { AtomicRelevanceInspector } from './atomic-relevance-inspector/atomic-relevance-inspector.js';
+export { AtomicResult } from './atomic-result/atomic-result.js';
+export { AtomicResultSectionActions } from './atomic-result-section-actions/atomic-result-section-actions.js';
+export { AtomicResultSectionBadges } from './atomic-result-section-badges/atomic-result-section-badges.js';
+export { AtomicResultSectionBottomMetadata } from './atomic-result-section-bottom-metadata/atomic-result-section-bottom-metadata.js';
+export { AtomicResultSectionChildren } from './atomic-result-section-children/atomic-result-section-children.js';
+export { AtomicResultSectionEmphasized } from './atomic-result-section-emphasized/atomic-result-section-emphasized.js';
+export { AtomicResultSectionExcerpt } from './atomic-result-section-excerpt/atomic-result-section-excerpt.js';
+export { AtomicResultSectionTitle } from './atomic-result-section-title/atomic-result-section-title.js';
+export { AtomicResultSectionTitleMetadata } from './atomic-result-section-title-metadata/atomic-result-section-title-metadata.js';
+export { AtomicResultSectionVisual } from './atomic-result-section-visual/atomic-result-section-visual.js';
 export { AtomicResultsPerPage } from './atomic-results-per-page/atomic-results-per-page.js';
 export { AtomicSearchBoxInstantResults } from './atomic-search-box-instant-results/atomic-search-box-instant-results.js';
 export { AtomicSearchBoxQuerySuggestions } from './atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.js';