@coveo/atomic 3.38.0 → 3.39.1

package/dist/types/components/common/result-children/show-hide-button.d.ts

@@ -1,5 +1,5 @@
-import { FunctionalComponent } from '../../../stencil-public-runtime';
-interface ShowHideButtonProps {
+import type { FunctionalComponent } from "../../../utils/functional-component-utils";
+export interface ShowHideButtonProps {
     moreResultsAvailable: boolean;
     loadFullCollection: () => void;
     showInitialChildren: boolean;
@@ -7,8 +7,4 @@ interface ShowHideButtonProps {
     loadAllResults: string;
     collapseResults: string;
 }
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const ShowHideButton: FunctionalComponent<ShowHideButtonProps>;
-export {};
+export declare const renderShowHideButton: FunctionalComponent<ShowHideButtonProps>;

package/dist/types/components/common/result-children/stencil-collection-guard.d.ts

@@ -0,0 +1,16 @@
+import { FunctionalComponent } from '../../../stencil-public-runtime';
+import { ItemDisplayDensity, ItemDisplayImageSize } from '../layout/display-options';
+interface CollectionGuardProps {
+    isLoadingMoreResults: boolean;
+    moreResultsAvailable: boolean;
+    hasChildren: boolean;
+    numberOfChildren: number;
+    density: ItemDisplayDensity;
+    imageSize: ItemDisplayImageSize;
+    noResultText: string;
+}
+/**
+ * @deprecated should only be used for Stencil components.
+ */
+export declare const CollectionGuard: FunctionalComponent<CollectionGuardProps>;
+export {};

package/dist/types/components/common/result-children/stencil-show-hide-button.d.ts

@@ -0,0 +1,14 @@
+import { FunctionalComponent } from '../../../stencil-public-runtime';
+interface ShowHideButtonProps {
+    moreResultsAvailable: boolean;
+    loadFullCollection: () => void;
+    showInitialChildren: boolean;
+    toggleShowInitialChildren: () => void;
+    loadAllResults: string;
+    collapseResults: string;
+}
+/**
+ * @deprecated should only be used for Stencil components.
+ */
+export declare const ShowHideButton: FunctionalComponent<ShowHideButtonProps>;
+export {};

package/dist/types/components/common/validate-props-controller/validate-props-controller.d.ts

@@ -8,12 +8,14 @@ import type { ReactiveController, ReactiveControllerHost } from 'lit';
  * the host updates, revalidating only if the props have changed since the last
  * validation.
  *
- * If validation fails, the controller sets the `error` property on the host.
+ * If validation fails, the controller either sets the `error` property on the host
+ * or logs a warning, depending on the `throwOnError` configuration.
  */
 export declare class ValidatePropsController<TProps extends Record<string, unknown>> implements ReactiveController {
     private host;
     private getProps;
     private schema;
+    private throwOnError;
     private currentProps?;
     private previousProps?;
     /**
@@ -22,11 +24,12 @@ export declare class ValidatePropsController<TProps extends Record<string, unkno
      * @param host The host element.
      * @param getProps A function that returns the current props to validate.
      * @param schema The Bueno schema to validate the props against.
+     * @param throwOnError Whether to throw an error (true) or log a warning (false) when validation fails. Defaults to true.
      */
     constructor(host: ReactiveControllerHost & HTMLElement & {
         error: Error;
-    }, getProps: () => TProps, schema: Schema<TProps>);
+    }, getProps: () => TProps, schema: Schema<TProps>, throwOnError?: boolean);
     hostConnected(): void;
     hostUpdate(): void;
-    private _validateProps;
+    private validateProps;
 }

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

@@ -2,7 +2,10 @@ import { FacetManager, FacetManagerState } from '@coveo/headless';
 import { InitializableComponent } from '../../../utils/initialization-utils';
 import { Bindings } from '../atomic-search-interface/atomic-search-interface';
 /**
- * The `atomic-breadbox` component creates breadcrumbs that display a summary of the currently active facet values.
+ * The `atomic-breadbox` component helps the user keep track of the navigational state of the currently active facet values, located in a single place on the search page.
+ * In most cases, these are on the top of a page between the search bar and the results.
+ * By default, the field name is displayed before the field value to clarify which facet the value is from.
+ * You can clear a single selection by clicking the `x` inside of each pill, or clear all selections by using the `Clear` button.
  *
  * @part container - The container of the whole component, list, and label.
  * @part breadcrumb-list-container - The container of the list of breadcrumb buttons.

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

@@ -75,7 +75,7 @@ export declare class AtomicFacet extends AtomicFacet_base implements Initializab
      * ```
      * If you don't set this property, the facet can be displayed on any tab. Otherwise, the facet can only be displayed on the specified tabs.
      */
-    tabsIncluded: string[] | string;
+    tabsIncluded: string[];
     /**
      * The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.
      *
@@ -85,7 +85,7 @@ export declare class AtomicFacet extends AtomicFacet_base implements Initializab
      * ```
      * If you don't set this property, the facet can be displayed on any tab. Otherwise, the facet won't be displayed on any of the specified tabs.
      */
-    tabsExcluded: string[] | string;
+    tabsExcluded: string[];
     /**
      * The number of values to request for this facet.
      * Also determines the number of additional values to request each time more values are shown.
@@ -205,6 +205,7 @@ export declare class AtomicFacet extends AtomicFacet_base implements Initializab
     private headerFocus?;
     private facetConditionsManager?;
     private facetSearchAriaLive?;
+    constructor();
     initialize(): void;
     disconnectedCallback(): void;
     shouldUpdate(changedProperties: Map<string, unknown>): boolean;

package/dist/types/components/search/atomic-field-condition/atomic-field-condition.d.ts

@@ -0,0 +1,45 @@
+import { LitElement } from 'lit';
+import type { Bindings } from "../atomic-search-interface/interfaces";
+import type { InitializableComponent } from "../../../decorators/types";
+declare const AtomicFieldCondition_base: import("../../../mixins/mixin-common").Constructor<{
+    injectStyles(dynamicStyles?: import("lit").CSSResultGroup): Promise<void>;
+}> & typeof LitElement;
+/**
+ * The `atomic-field-condition` component conditionally renders content based on result properties.
+ * Supports checking if fields are defined/undefined or match/don't match specific values.
+ *
+ * @slot default - The content to display if the conditions are met.
+ */
+export declare class AtomicFieldCondition extends AtomicFieldCondition_base implements InitializableComponent<Bindings> {
+    bindings: Bindings;
+    error: Error;
+    private resultController;
+    /**
+     * A condition that is satisfied when the specified field is defined on a result (e.g., `if-defined="author"` is satisfied when a result has the `author` field).
+     */
+    ifDefined?: string;
+    /**
+     * A condition that is satisfied when the specified field is not defined on a result (e.g., `if-not-defined="author"` is satisfied when a result does not have the `author` field).
+     */
+    ifNotDefined?: string;
+    /**
+     * A condition that is satisfied when the specified field matches one of the specified values on a result (e.g., `must-match-filetype="pdf,docx"` is satisfied when a result has a filetype of either pdf or docx).
+     * @type {Record<string, string[]>}
+     */
+    mustMatch: Record<string, string[]>;
+    /**
+     * A condition that is satisfied when the specified field does not match any of the specified values on a result (e.g., `must-not-match-filetype="pdf"` is satisfied when a result does not have a filetype of pdf).
+     * @type {Record<string, string[]>}
+     */
+    mustNotMatch: Record<string, string[]>;
+    initialize(): void;
+    private get conditions();
+    private getResult;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-field-condition': AtomicFieldCondition;
+    }
+}
+export {};

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

@@ -1,5 +1,5 @@
 import { type Pager, type PagerState, type SearchStatus, type SearchStatusState } from '@coveo/headless';
-import { LitElement, type PropertyValues } from 'lit';
+import { LitElement } from 'lit';
 import type { Bindings } from "../atomic-search-interface/interfaces";
 import type { InitializableComponent } from "../../../decorators/types";
 import { AriaLiveRegionController } from "../../../utils/accessibility-utils";
@@ -19,7 +19,6 @@ declare const AtomicPager_base: typeof LitElement;
  * @event atomic/scrollToTop - Emitted when the user clicks any of the buttons rendered by the component.
  */
 export declare class AtomicPager extends AtomicPager_base implements InitializableComponent<Bindings> {
-    private static propsSchema;
     bindings: Bindings;
     error: Error;
     private isAppLoaded;
@@ -51,10 +50,9 @@ export declare class AtomicPager extends AtomicPager_base implements Initializab
     private radioGroupName;
     private previousButton;
     private nextButton;
+    constructor();
     initialize(): void;
-    willUpdate(changedProperties: PropertyValues): void;
     render(): import("lit").TemplateResult<1>;
-    private validateProps;
     private initFocusTargets;
     private handleFocus;
     private focusOnFirstResultAndScrollToTop;

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

@@ -0,0 +1,80 @@
+import { LitElement } from 'lit';
+import "../../common/atomic-icon/atomic-icon";
+import "../atomic-text/atomic-text";
+import "../atomic-result-text/atomic-result-text";
+import type { InitializableComponent } from "../../../decorators/types";
+import type { Bindings } from '../atomic-search-interface/atomic-search-interface';
+/**
+ * The `atomic-result-badge` element renders a badge to highlight special features of a result.
+ *
+ * A badge can either display:
+ * * Text:
+ * ```html
+ * <atomic-result-badge label="trending"></atomic-result-badge>
+ * ```
+ * * The contents of a single-value field:
+ * ```html
+ * <atomic-result-badge field="objecttype"></atomic-result-badge>
+ * ```
+ * * An icon:
+ * ```html
+ * <atomic-result-badge icon="https://my-website.fake/star.svg"></atomic-result-badge>
+ * ```
+ * * Slotted elements:
+ * ```html
+ * <atomic-result-badge icon="https://my-website.fake/stopwatch.svg">
+ *     Deal ends in <my-dynamic-countdown></my-dynamic-countdown>
+ * </atomic-result-badge>
+ * ```
+ *
+ * The contents of a multi-value field can be displayed as in the following example:
+ * ```html
+ * <atomic-result-badge icon="https://my-website.fake/language.svg">
+ *    <atomic-result-multi-value-text field="language"></atomic-result-multi-value-text>
+ * </atomic-result-badge>
+ * ```
+ *
+ * @part result-badge-element - The decorative outer-most element with the background color and text color.
+ * @part result-badge-icon - The icon displayed at the left-end of the badge, if present.
+ * @part result-badge-label - The wrapper around the contents at the right-end of the badge. This may be text, a field or slotted elements depending on which was configured.
+ * @slot default - The elements to display inside the badge, instead of a field or label.
+ */
+export declare class AtomicResultBadge extends LitElement implements InitializableComponent<Bindings> {
+    bindings: Bindings;
+    error: Error;
+    initialize(): void;
+    static styles: import("lit").CSSResult;
+    private resultContext;
+    /**
+     * The field to display in the badge.
+     *
+     * Not compatible with `label`, slotted elements nor multi-value fields.
+     */
+    field?: string;
+    /**
+     * The text to display in the badge.
+     *
+     * Not compatible with `field` nor slotted elements.
+     */
+    label?: string;
+    /**
+     * Specifies an icon to display at the left-end of the badge.
+     * This can be used in conjunction with `field`, `label` or slotted elements.
+     *
+     * - Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.
+     * - Use a value that starts with `assets://`, to display an icon from the Atomic package.
+     * - Use a stringified SVG to display it directly
+     */
+    icon?: string;
+    private renderIcon;
+    private getTextContent;
+    private renderText;
+    private renderBadge;
+    willUpdate(): void;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-badge': AtomicResultBadge;
+    }
+}

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

@@ -0,0 +1,41 @@
+import { LitElement } from 'lit';
+import type { Bindings } from "../atomic-search-interface/atomic-search-interface";
+import type { InitializableComponent } from "../../../decorators/types";
+import '../atomic-html/atomic-html';
+declare const AtomicResultHtml_base: import("../../../mixins/mixin-common").Constructor<{
+    injectStyles(dynamicStyles?: import("lit").CSSResultGroup): Promise<void>;
+}> & typeof LitElement;
+/**
+ * The `atomic-result-html` component renders the HTML value of a string result field.
+ *
+ * There is an inherent XSS security concern associated with the usage of this component.
+ *
+ * Use only with fields for which you are certain the data is harmless.
+ */
+export declare class AtomicResultHtml extends AtomicResultHtml_base implements InitializableComponent<Bindings> {
+    /**
+     * The result field which the component should use.
+     * Searches for the specified field in the property of `Result` then `Result.raw`.
+     * If unset, the component will not render.
+     * It's important to include the necessary field in the `ResultList` component.
+     */
+    field?: string;
+    /**
+     * Specify if the content should be sanitized, using [`DOMPurify`](https://www.npmjs.com/package/dompurify).
+     */
+    sanitize: boolean;
+    private result?;
+    bindings: Bindings;
+    error: Error;
+    private resultController;
+    constructor();
+    initialize(): void;
+    render(): import("lit").TemplateResult<1>;
+    private renderResultHtml;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'atomic-result-html': AtomicResultHtml;
+    }
+}
+export {};

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

@@ -1,5 +1,6 @@
 export { AtomicExternal } from './atomic-external/atomic-external.js';
 export { AtomicFacet } from './atomic-facet/atomic-facet.js';
+export { AtomicFieldCondition } from './atomic-field-condition/atomic-field-condition.js';
 export { AtomicHtml } from './atomic-html/atomic-html.js';
 export { AtomicLoadMoreResults } from './atomic-load-more-results/atomic-load-more-results.js';
 export { AtomicPager } from './atomic-pager/atomic-pager.js';
@@ -7,7 +8,9 @@ export { AtomicQueryError } from './atomic-query-error/atomic-query-error.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 { AtomicResultBadge } from './atomic-result-badge/atomic-result-badge.js';
 export { AtomicResultChildrenTemplate } from './atomic-result-children-template/atomic-result-children-template.js';
+export { AtomicResultHtml } from './atomic-result-html/atomic-result-html.js';
 export { AtomicResultList } from './atomic-result-list/atomic-result-list.js';
 export { AtomicResultNumber } from './atomic-result-number/atomic-result-number.js';
 export { AtomicResultSectionActions } from './atomic-result-section-actions/atomic-result-section-actions.js';

package/dist/types/components/search/result-template-components/quickview-word-highlight/color-parser.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @internal
+ */
+export declare class ColorParser {
+    private color;
+    private static readonly REGEX;
+    private red;
+    private green;
+    private blue;
+    constructor(color: string);
+    rgb(): string;
+    rgbInverted(): string;
+    rgbSaturated(): string;
+    private rgbString;
+}

package/dist/types/components/search/result-template-components/quickview-word-highlight/iframe-parser.d.ts

@@ -0,0 +1,16 @@
+import type { TermsToHighlight } from '@coveo/headless';
+import { QuickviewWordHighlight } from './quickview-word-highlight';
+export declare const HIGHLIGHT_PREFIX = "CoveoHighlight";
+/**
+ * @internal
+ */
+export declare class IframeParser {
+    private stemmingInfoFromIndex;
+    private iframe?;
+    private textParser;
+    private wordsHighlights;
+    constructor(stemmingInfoFromIndex: TermsToHighlight, iframe?: HTMLIFrameElement | undefined);
+    parse(): Record<string, QuickviewWordHighlight>;
+    private parseIdentifier;
+}
+export declare const getWordsHighlights: (stemmingInfoFromIndex: TermsToHighlight, iframe?: HTMLIFrameElement) => Record<string, QuickviewWordHighlight>;

package/dist/types/components/search/result-template-components/quickview-word-highlight/quickview-word-highlight.d.ts

@@ -1,29 +1,17 @@
-import { TermsToHighlight } from '@coveo/headless';
-export declare const HIGHLIGHT_PREFIX = "CoveoHighlight";
+export { getWordsHighlights, HIGHLIGHT_PREFIX } from './iframe-parser';
 export declare class QuickviewWordHighlight {
-    private stemmingInfoFromIndex;
-    text: string;
-    indexIdentifier: string;
-    occurrences: number;
-    color: string;
-    focusedColor: string;
-    previewBorderColor: string;
-    elements: HTMLElement[];
+    readonly indexIdentifier: string;
+    readonly text: string;
+    readonly color: string;
+    readonly focusedColor: string;
+    readonly previewBorderColor: string;
+    readonly elements: HTMLElement[];
     private currentNavigationPosition;
-    constructor(stemmingInfoFromIndex: TermsToHighlight, keywordElementInIframe: HTMLElement);
-    addElement(keywordElementInIframe: HTMLElement): void;
+    constructor(indexIdentifier: string, text: string, color: string, element: HTMLElement);
+    addElement(element: HTMLElement): void;
+    get occurrences(): number;
     navigateForward(): HTMLElement;
     navigateBackward(): HTMLElement;
-    private isTaggedWord;
     private highlightNavigation;
     private putElementIntoView;
-    private getText;
-    private resolveOriginalTerm;
-    private getHighlightedInnerText;
-    private parseKeywordIdentifier;
-    private getTextOfHTMLElement;
-    private computeInvertedColor;
-    private computeSaturatedColor;
-    private extractRgb;
 }
-export declare const getWordsHighlights: (stemmingInfoFromIndex: TermsToHighlight, iframe?: HTMLIFrameElement) => Record<string, QuickviewWordHighlight>;

package/dist/types/components/search/result-template-components/quickview-word-highlight/text-parser.d.ts

@@ -0,0 +1,13 @@
+import type { TermsToHighlight } from '@coveo/headless';
+/**
+ * @internal
+ */
+export declare class TextParser {
+    private stemmingInfoFromIndex;
+    constructor(stemmingInfoFromIndex: TermsToHighlight);
+    parse(element: HTMLElement): string;
+    private isTaggedWord;
+    private getHighlightedInnerText;
+    private getTextOfHTMLElement;
+    private resolveOriginalTerm;
+}