@coveo/atomic 3.34.0-pre.4c6dc408dd → 3.34.0-pre.4f2ee671ee

package/dist/esm/result-template-common-ac9fecab.js.map

@@ -1 +0,0 @@
-{"file":"result-template-common-ac9fecab.js","mappings":";;;;;;SA0BgB,mBAAmB,CAAC,IAAU;IAC5C,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE;QAC7B,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,UAAU,CAAC;KACnB;IACD,IACE,aAAa,CAAC,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,mBAAmB,EAClD;QACA,OAAO,yBAAyB,CAAC;KAClC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAe;IACvC,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,KAAK,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3E,CAAC;MAEY,oBAAoB;IAK/B,YAAY,EACV,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,UAAU,GAAG,KAAK,GACQ;QARrB,oBAAe,GAA8B,EAAE,CAAC;QAC/C,uBAAkB,GAAe,OAAO,CAAC;QAQ/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;KACjE;IAED,gBAAgB,CACd,IAAoB,EACpB,QAAgC,EAChC,YAAsB,EACtB,UAAU,GAAG,IAAI;QAEjB,MAAM,cAAc,GAAG,YAAY;aAChC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;aAC3B,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,cAAc,EAAE;YACnB,QAAQ,CACN,IAAI,KAAK,CACP,QAAQ,OAAO,4DAA4D,YAAY;iBACpF,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC;iBAClC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,CACF,CAAC;YACF,OAAO;SACR;QAED,IACE,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,KAAK,MAAM,EACxE;YACA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,YAAY,CACnE,uBAAuB,CACxB,EAAE,KAAmB,CAAC;SACxB;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CACjC,sBAAsB,CACvB,CAAC;QACF,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,CACN,IAAI,KAAK,CACP,QAAQ,OAAO,6DAA6D,CAC7E,CACF,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE;YAC7C,QAAQ,CACN,IAAI,KAAK,CAAC,8BAA8B,OAAO,oBAAoB,CAAC,CACrE,CAAC;YACF,OAAO;SACR;QAED,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;YAC5C,OAAO,CAAC,IAAI,CACV,mIAAmI,EACnI,IAAI,CACL,CAAC;SACH;QAED,MAAM,EAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAC,GAAG,gBAAgB,CACjE,QAAQ,CAAC,OAAO,CAAC,UAAU,CAC5B,CAAC;QACF,IAAI,YAAY,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,EAAE;YAC9C,OAAO,CAAC,IAAI,CACV,gJAAgJ,EAChJ,IAAI,EACJ,EAAC,YAAY,EAAE,UAAU,EAAC,CAC3B,CAAC;SACH;KACF;IAED,WAAW,CACT,UAAqC,EACrC,KAAY;QAEZ,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC;SACb;QAED,OAAO;YACL,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YACnD,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAQ;YAC/C,WAAW,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAQ;YAC5D,QAAQ,EAAE,CAAC;SACZ,CAAC;KACH;IAED,aAAa,CAAC,KAAY;QACxB,IAAI,KAAK,EAAE;YACT,QACE,8BACE,OAAO,EAAE,IAAI,CAAC,IAAI,EAClB,KAAK,EAAE,KAAK,GACY,EAC1B;SACH;KACF;IAED,6BAA6B;QAC3B,MAAM,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACxD,YAAY,CAAC,SAAS,GAAG,uBAAuB,IAAI,CAAC,kBAAkB,GAAG,gCAAgC,IAAI,CAAC,kBAAkB,QAAQ,GAAG,EAAE,uBAAuB,CAAC;QACtK,OAAO,YAAY,CAAC;KACrB;IAED,sBAAsB,CAAC,IAAiB;QACtC,QACE,IAAI,CAAC,aAAa,CAAsB,uBAAuB,CAAC;YAChE,IAAI,CAAC,6BAA6B,EAAE,EACpC;KACH;CACF;AAED,SAAS,kBAAkB,CAAC,IAAiB;IAC3C,OAAO,IAAI,CAAC,aAAa,CAAsB,sBAAsB,CAAE,CAAC;AAC1E,CAAC;SAEe,mBAAmB,CACjC,SAAmC,EACnC,YAAsC;IAEtC,MAAM,UAAU,GAA8B,EAAE,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE;QAC7B,UAAU,CAAC,IAAI,CACb,sBAAsB,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAC/D,CAAC;KACH;IAED,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;QAChC,UAAU,CAAC,IAAI,CACb,sBAAsB,CAAC,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CACrE,CAAC;KACH;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;SAEe,qBAAqB,CACnC,SAAkB,EAClB,YAAqB;IAErB,MAAM,UAAU,GAA8B,EAAE,CAAC;IACjD,IAAI,SAAS,EAAE;QACb,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,UAAU,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;KACzE;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,UAAU,CAAC,IAAI,CAAC,sBAAsB,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC;KAC5E;IACD,OAAO,UAAU,CAAC;AACpB;;;;","names":[],"sources":["src/components/common/result-templates/result-template-common.tsx"],"sourcesContent":["import {\n  ResultTemplate,\n  ResultTemplateCondition,\n  ResultTemplatesHelpers,\n} from '@coveo/headless';\nimport {h} from '@stencil/core';\nimport {aggregate, isElementNode, isVisualNode} from '../../../utils/utils';\nimport {tableElementTagName} from '../../search/atomic-table-result/table-element-utils';\nimport {ItemTarget} from '../layout/display-options';\nimport {isResultSectionNode} from '../layout/sections';\n\nexport type TemplateContent = DocumentFragment;\n\ninterface ResultTemplateCommonProps {\n  allowEmpty?: boolean;\n  host: HTMLDivElement;\n  validParents: string[];\n  setError: (error: Error) => void;\n}\n\ntype TemplateNodeType =\n  | 'section'\n  | 'metadata'\n  | 'table-column-definition'\n  | 'other';\n\nexport function getTemplateNodeType(node: Node): TemplateNodeType {\n  if (isResultSectionNode(node)) {\n    return 'section';\n  }\n  if (!isVisualNode(node)) {\n    return 'metadata';\n  }\n  if (\n    isElementNode(node) &&\n    node.tagName.toLowerCase() === tableElementTagName\n  ) {\n    return 'table-column-definition';\n  }\n  return 'other';\n}\n\nfunction groupNodesByType(nodes: NodeList) {\n  return aggregate(Array.from(nodes), (node) => getTemplateNodeType(node));\n}\n\nexport class ResultTemplateCommon {\n  private host: HTMLDivElement;\n  public matchConditions: ResultTemplateCondition[] = [];\n  private gridCellLinkTarget: ItemTarget = '_self';\n\n  constructor({\n    host,\n    setError,\n    validParents,\n    allowEmpty = false,\n  }: ResultTemplateCommonProps) {\n    this.host = host;\n    this.validateTemplate(host, setError, validParents, allowEmpty);\n  }\n\n  validateTemplate(\n    host: HTMLDivElement,\n    setError: (error: Error) => void,\n    validParents: string[],\n    allowEmpty = true\n  ) {\n    const hasValidParent = validParents\n      .map((p) => p.toUpperCase())\n      .includes(host.parentElement?.nodeName || '');\n    const tagName = host.nodeName.toLowerCase();\n\n    if (!hasValidParent) {\n      setError(\n        new Error(\n          `The \"${tagName}\" component has to be the child of one of the following: ${validParents\n            .map((p) => `\"${p.toLowerCase()}\"`)\n            .join(', ')}.`\n        )\n      );\n      return;\n    }\n\n    if (\n      host.parentElement?.attributes.getNamedItem('display')?.value === 'grid'\n    ) {\n      this.gridCellLinkTarget = host.parentElement?.attributes.getNamedItem(\n        'grid-cell-link-target'\n      )?.value as ItemTarget;\n    }\n\n    const template = host.querySelector<HTMLTemplateElement>(\n      'template:not([slot])'\n    );\n    if (!template) {\n      setError(\n        new Error(\n          `The \"${tagName}\" component has to contain a \"template\" element as a child.`\n        )\n      );\n      return;\n    }\n\n    if (!allowEmpty && !template.innerHTML.trim()) {\n      setError(\n        new Error(`The \"template\" tag inside \"${tagName}\" cannot be empty.`)\n      );\n      return;\n    }\n\n    if (template.content.querySelector('script')) {\n      console.warn(\n        'Any \"script\" tags defined inside of \"template\" elements are not supported and will not be executed when the results are rendered.',\n        host\n      );\n    }\n\n    const {section: sectionNodes, other: otherNodes} = groupNodesByType(\n      template.content.childNodes\n    );\n    if (sectionNodes?.length && otherNodes?.length) {\n      console.warn(\n        'Result templates should only contain section elements or non-section elements. Future updates could unpredictably affect this result template.',\n        host,\n        {sectionNodes, otherNodes}\n      );\n    }\n  }\n\n  getTemplate(\n    conditions: ResultTemplateCondition[],\n    error: Error\n  ): ResultTemplate<TemplateContent> | null {\n    if (error) {\n      return null;\n    }\n\n    return {\n      conditions: conditions.concat(this.matchConditions),\n      content: getTemplateElement(this.host).content!,\n      linkContent: this.getLinkTemplateElement(this.host).content!,\n      priority: 1,\n    };\n  }\n\n  renderIfError(error: Error) {\n    if (error) {\n      return (\n        <atomic-component-error\n          element={this.host}\n          error={error}\n        ></atomic-component-error>\n      );\n    }\n  }\n\n  getDefaultLinkTemplateElement() {\n    const linkTemplate = document.createElement('template');\n    linkTemplate.innerHTML = `<atomic-result-link>${this.gridCellLinkTarget ? `<a slot=\"attributes\" target=\"${this.gridCellLinkTarget}\"></a>` : ''}</atomic-result-link>`;\n    return linkTemplate;\n  }\n\n  getLinkTemplateElement(host: HTMLElement) {\n    return (\n      host.querySelector<HTMLTemplateElement>('template[slot=\"link\"]') ??\n      this.getDefaultLinkTemplateElement()\n    );\n  }\n}\n\nfunction getTemplateElement(host: HTMLElement) {\n  return host.querySelector<HTMLTemplateElement>('template:not([slot])')!;\n}\n\nexport function makeMatchConditions(\n  mustMatch: Record<string, string[]>,\n  mustNotMatch: Record<string, string[]>\n): ResultTemplateCondition[] {\n  const conditions: ResultTemplateCondition[] = [];\n  for (const field in mustMatch) {\n    conditions.push(\n      ResultTemplatesHelpers.fieldMustMatch(field, mustMatch[field])\n    );\n  }\n\n  for (const field in mustNotMatch) {\n    conditions.push(\n      ResultTemplatesHelpers.fieldMustNotMatch(field, mustNotMatch[field])\n    );\n  }\n  return conditions;\n}\n\nexport function makeDefinedConditions(\n  ifDefined?: string,\n  ifNotDefined?: string\n): ResultTemplateCondition[] {\n  const conditions: ResultTemplateCondition[] = [];\n  if (ifDefined) {\n    const fieldNames = ifDefined.split(',');\n    conditions.push(ResultTemplatesHelpers.fieldsMustBeDefined(fieldNames));\n  }\n\n  if (ifNotDefined) {\n    const fieldNames = ifNotDefined.split(',');\n    conditions.push(ResultTemplatesHelpers.fieldsMustNotBeDefined(fieldNames));\n  }\n  return conditions;\n}\n"],"version":3}

package/dist/esm/sections-ae00b53a.js.map

@@ -1 +0,0 @@
-{"file":"sections-ae00b53a.js","mappings":"SAYgB,WAAW,CAAC,OAAoB,EAAE,OAAgB;IAChE,OAAO,OAAO,CAAC,aAAa,CAC1B,eAAe,CAAC,OAAO,CAAC,CACK,CAAC;AAClC,CAAC;SAEe,eAAe,CAAC,OAAgB;IAC9C,OAAO,kCAAkC,OAAO,IAAI,CAAC;AACvD;;;;","names":[],"sources":["src/components/common/atomic-layout-section/sections.ts"],"sourcesContent":["import type {AtomicLayoutSection} from './atomic-layout-section';\n\nexport type Section =\n  | 'search'\n  | 'facets'\n  | 'main'\n  | 'status'\n  | 'results'\n  | 'horizontal-facets'\n  | 'products'\n  | 'pagination';\n\nexport function findSection(element: HTMLElement, section: Section) {\n  return element.querySelector(\n    sectionSelector(section)\n  ) as AtomicLayoutSection | null;\n}\n\nexport function sectionSelector(section: Section) {\n  return `atomic-layout-section[section=\"${section}\"]`;\n}\n"],"version":3}

package/dist/types/components/common/layout/sections.d.ts

@@ -1,6 +0,0 @@
-declare const allTags: Set<"atomic-result-section-actions" | "atomic-result-section-badges" | "atomic-result-section-bottom-metadata" | "atomic-result-section-children" | "atomic-result-section-emphasized" | "atomic-result-section-excerpt" | "atomic-result-section-title" | "atomic-result-section-title-metadata" | "atomic-result-section-visual" | "atomic-product-section-actions" | "atomic-product-section-badges" | "atomic-product-section-bottom-metadata" | "atomic-product-section-children" | "atomic-product-section-description" | "atomic-product-section-emphasized" | "atomic-product-section-metadata" | "atomic-product-section-name" | "atomic-product-section-visual">;
-type SetValueType<T> = T extends Set<infer U> ? U : never;
-export type ItemSectionTagName = SetValueType<typeof allTags>;
-export declare function isResultSectionNode(element: Node): boolean;
-export declare function containsSections(content: string | NodeList | HTMLCollection): boolean;
-export {};

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

@@ -1,10 +0,0 @@
-/**
- * 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 {
-    private host;
-    componentDidRender(): void;
-}

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

@@ -1,12 +0,0 @@
-/**
- * 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 {
-    private host;
-    componentDidRender(): void;
-}

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

@@ -1,13 +0,0 @@
-/**
- * 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 {
-    private host;
-    componentDidRender(): void;
-}

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

@@ -1,20 +0,0 @@
-import { ItemDisplayImageSize } from '../../../common/layout/display-options';
-/**
- * This section provides visual information about the item.
- * For example, in Commerce, an image is a great shorthand for a product 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 {
-    private host;
-    /**
-     * How large or small the visual section of results using this template should be.
-     */
-    imageSize?: ItemDisplayImageSize;
-    componentDidRender(): void;
-}

package/dist/types/components/search/search-box-suggestions/atomic-search-box-recent-queries/atomic-search-box-recent-queries.d.ts

@@ -1,37 +0,0 @@
-/**
- * The `atomic-search-box-recent-queries` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of recent query suggestions.
- */
-export declare class AtomicSearchBoxRecentQueries {
-    private bindings;
-    private recentQueriesList;
-    private storage;
-    private host;
-    error: Error;
-    /**
-     * The SVG icon to display.
-     *
-     * - 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;
-    /**
-     * The maximum number of suggestions that will be displayed if the user has typed something into the input field.
-     */
-    maxWithQuery: number;
-    /**
-     * The maximum number of suggestions that will be displayed initially when the input field is empty.
-     */
-    maxWithoutQuery?: number;
-    componentWillLoad(): void;
-    private renderIcon;
-    private initialize;
-    private retrieveLocalStorage;
-    private updateLocalStorage;
-    private warnUser;
-    private disableFeature;
-    private renderItems;
-    private renderClear;
-    private renderItem;
-    render(): any;
-}