@coveo/atomic 3.46.1 → 3.47.1

package/dist/esm/stencil-result-template-decorators-c244d674.js

@@ -1,38 +0,0 @@
-import { I as ItemContext, a as InteractiveItemContext, i as itemContext } from './stencil-item-decorators-97a4c6a1.js';
-
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) to be used for result template components.
- * This allows the Stencil component to fetch the current result from its rendered parent, the `atomic-result` component.
- *
- * Example:
- * @ResultContext() private result!: Result;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `createResultContextController` from \@/src/components/search/result-template-component-utils/context/result-context-controller.ts
- */
-function ResultContext(opts = { folded: false }) {
-    return ItemContext({ parentName: 'atomic-result', folded: opts.folded });
-}
-function InteractiveResultContext() {
-    return InteractiveItemContext();
-}
-/**
- * Retrieves `Result` on a rendered `atomic-result`.
- *
- * This method is useful for building custom result template elements, see [Create a Result List](https://docs.coveo.com/en/atomic/latest/cc-search/create-custom-components/native-components/#custom-result-template-component-example) for more information.
- *
- * You should use the method in the [connectedCallback lifecycle method](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).
- *
- * @param element The element that the event is dispatched to, which must be the child of a rendered "atomic-result" element.
- * @returns A promise that resolves on initialization of the parent "atomic-result" element, or rejects when there is no parent "atomic-result" element.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `fetchResultContext` from \@/src/components/search/result-template-component-utils/context/fetch-result-context.ts
- */
-function resultContext(element) {
-    return itemContext(element, 'atomic-result');
-}
-
-export { InteractiveResultContext as I, ResultContext as R, resultContext as r };
-
-//# sourceMappingURL=stencil-result-template-decorators-c244d674.js.map

package/dist/esm/stencil-result-template-decorators-c244d674.js.map

@@ -1 +0,0 @@
-{"file":"stencil-result-template-decorators-c244d674.js","mappings":";;AASA;;;;;;;;;;;SAWgB,aAAa,CAAC,OAA0B,EAAC,MAAM,EAAE,KAAK,EAAC;IACrE,OAAO,WAAW,CAAC,EAAC,UAAU,EAAE,eAAe,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAC,CAAC,CAAC;AACzE,CAAC;SAEe,wBAAwB;IACtC,OAAO,sBAAsB,EAAE,CAAC;AAClC,CAAC;AAKD;;;;;;;;;;;;SAYgB,aAAa,CAC3B,OAAgB;IAEhB,OAAO,WAAW,CAAI,OAAO,EAAE,eAAe,CAAC,CAAC;AAClD;;;;","names":[],"sources":["src/components/search/result-template-component-utils/context/stencil-result-template-decorators.tsx"],"sourcesContent":["import {FoldedResult, Result} from '@coveo/headless';\nimport {\n  InteractiveItemContext,\n  InteractiveItemContextEvent,\n  ItemContext,\n  ItemContextEvent,\n  itemContext,\n} from '@/src/components/common/item-list/stencil-item-decorators';\n\n/**\n * A [StencilJS property decorator](https://stenciljs.com/) to be used for result template components.\n * This allows the Stencil component to fetch the current result from its rendered parent, the `atomic-result` component.\n *\n * Example:\n * @ResultContext() private result!: Result;\n *\n * For more information and examples, view the \"Utilities\" section of the readme.\n * \n * @deprecated should only be used for Stencil components. For Lit components, use `createResultContextController` from \\@/src/components/search/result-template-component-utils/context/result-context-controller.ts\n */\nexport function ResultContext(opts: {folded: boolean} = {folded: false}) {\n  return ItemContext({parentName: 'atomic-result', folded: opts.folded});\n}\n\nexport function InteractiveResultContext() {\n  return InteractiveItemContext();\n}\n\nexport type ResultContextEvent<T = Result> = ItemContextEvent<T>;\nexport type InteractiveResultContextEvent = InteractiveItemContextEvent;\n\n/**\n * Retrieves `Result` on a rendered `atomic-result`.\n *\n * This method is useful for building custom result template elements, see [Create a Result List](https://docs.coveo.com/en/atomic/latest/cc-search/create-custom-components/native-components/#custom-result-template-component-example) for more information.\n *\n * You should use the method in the [connectedCallback lifecycle method](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).\n *\n * @param element The element that the event is dispatched to, which must be the child of a rendered \"atomic-result\" element.\n * @returns A promise that resolves on initialization of the parent \"atomic-result\" element, or rejects when there is no parent \"atomic-result\" element.\n * \n * @deprecated should only be used for Stencil components. For Lit components, use `fetchResultContext` from \\@/src/components/search/result-template-component-utils/context/fetch-result-context.ts\n */\nexport function resultContext<T extends Result | FoldedResult = Result>(\n  element: Element\n) {\n  return itemContext<T>(element, 'atomic-result');\n}\n"],"version":3}

package/dist/esm/unfolded-item-c5795c0f.js

@@ -1,7 +0,0 @@
-function extractUnfoldedItem(anyResult) {
-    return anyResult.result || anyResult;
-}
-
-export { extractUnfoldedItem as e };
-
-//# sourceMappingURL=unfolded-item-c5795c0f.js.map

package/dist/esm/unfolded-item-c5795c0f.js.map

@@ -1 +0,0 @@
-{"file":"unfolded-item-c5795c0f.js","mappings":"SAOgB,mBAAmB,CAAC,SAAkB;IACpD,OAAQ,SAA0B,CAAC,MAAM,IAAI,SAAS,CAAC;AACzD;;;;","names":[],"sources":["src/components/common/item-list/unfolded-item.ts"],"sourcesContent":["import type {FoldedResult, Result} from '@coveo/headless';\nimport type {Product} from '@coveo/headless/commerce';\nimport type {Result as InsightResult} from '@coveo/headless/insight';\n\nexport type AnyItem = FoldedResult | AnyUnfoldedItem | Product;\nexport type AnyUnfoldedItem = Result | InsightResult;\n\nexport function extractUnfoldedItem(anyResult: AnyItem): AnyUnfoldedItem {\n  return (anyResult as FoldedResult).result || anyResult;\n}\n"],"version":3}

package/dist/esm/utils-58ed73e4.js.map

@@ -1 +0,0 @@
-{"file":"utils-58ed73e4.js","mappings":";;AAEA;;;SAGgB,IAAI,CAAyB,EAAqB;IAChE,IAAI,MAAS,CAAC;IACd,IAAI,QAAQ,GAA+B,EAAE,CAAC;IAC9C,OAAO,UAAyB,GAAG,IAAO;QACxC,IAAI,QAAQ,EAAE;YACZ,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,QAAQ,GAAG,IAAI,CAAC;SACjB;QACD,OAAO,MAAM,CAAC;KACf,CAAC;AACJ,CAAC;SAEe,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;AAC9E,CAAC;SAEe,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACzD,CAAC;SAYe,QAAQ,CAAC,OAAgB,EAAE,MAAM,GAAG,CAAC;IACnD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE;SAC5B,QAAQ,CAAC,EAAE,CAAC;SACZ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,OAAO,GAAG,SAAS,CAAC;AAC7B,CAAC;SAce,aAAa,CAAC,IAAU;IACtC,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,CAAC;AAC7C,CAAC;SAEe,UAAU,CAAC,IAAU;IACnC,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,CAAC;AAC1C,CAAC;SAEe,YAAY,CAAC,IAAU;IACrC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,EAAE,IAAI,YAAY,gBAAgB,CAAC,CAAC;KAC5C;IACD,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE;QACpB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;KACnC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;SAEe,qBAAqB,CAAC,IAAU;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;YACvB,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;SAEe,qBAAqB,CACnC,EAAe,EACf,OAAe;IAEf,MAAM,aAAa,GAAG,EAAE,CAAC,aAAa,CAAC;IACvC,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IACD,IAAI,aAAa,CAAC,OAAO,KAAK,OAAO,CAAC,WAAW,EAAE,EAAE;QACnD,OAAO,IAAI,CAAC;KACb;IACD,OAAO,qBAAqB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;SAoFe,SAAS,CACvB,MAAoB,EACpB,MAAsC;IAEtC,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC7B,IAAI,EAAE,GAAG,IAAI,gBAAgB,CAAC,EAAE;YAC9B,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;SAC5B;QACD,gBAAgB,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,gBAAgB,CAAC;KACzB,EAC2B,EAAE,CAC/B,CAAC;AACJ,CAAC;AAyBM,eAAe,KAAK;IACzB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,KAAK,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACjE;;;;","names":[],"sources":["src/utils/utils.ts"],"sourcesContent":["import DOMPurify from 'dompurify';\n\n/**\n * Returns a function that can be executed only once\n */\nexport function once<T extends unknown[], R>(fn: (...args: T) => R) {\n  let result: R;\n  let callable: ((...args: T) => R) | null = fn;\n  return function (this: unknown, ...args: T) {\n    if (callable) {\n      result = callable.apply(this, args);\n      callable = null; // Allow garbage collection\n    }\n    return result;\n  };\n}\n\nexport function camelToKebab(value: string) {\n  return value.replace(/([a-z0-9]|(?=[A-Z]))([A-Z])/g, '$1-$2').toLowerCase();\n}\n\nexport function kebabToCamel(value: string) {\n  return value.replace(/-./g, (x) => x[1].toUpperCase());\n}\n\nexport function snakeToCamel(value: string) {\n  return value\n    .toLowerCase()\n    .replace(/([_][a-z])/g, (group) => group.toUpperCase().replace('_', ''));\n}\n\nexport function titleToKebab(value: string) {\n  return value.replace(/\\s/g, '-').toLowerCase();\n}\n\nexport function randomID(prepend?: string, length = 5) {\n  const randomStr = Math.random()\n    .toString(36)\n    .substring(2, 2 + length);\n  if (!prepend) {\n    return randomStr;\n  }\n  return prepend + randomStr;\n}\n\nexport function getRandomArbitrary(min: number, max: number) {\n  return Math.random() * (max - min) + min;\n}\n\nexport function parseXML(string: string) {\n  return new window.DOMParser().parseFromString(string, 'text/xml');\n}\n\nexport function parseHTML(string: string) {\n  return new window.DOMParser().parseFromString(string, 'text/html');\n}\n\nexport function isElementNode(node: Node): node is Element {\n  return node.nodeType === Node.ELEMENT_NODE;\n}\n\nexport function isTextNode(node: Node): node is Text {\n  return node.nodeType === Node.TEXT_NODE;\n}\n\nexport function isVisualNode(node: Node) {\n  if (isElementNode(node)) {\n    return !(node instanceof HTMLStyleElement);\n  }\n  if (isTextNode(node)) {\n    return !!node.textContent?.trim();\n  }\n  return false;\n}\n\nexport function containsVisualElement(node: Node) {\n  for (let i = 0; i < node.childNodes.length; i++) {\n    const child = node.childNodes.item(i);\n    if (isVisualNode(child)) {\n      return true;\n    }\n  }\n  return false;\n}\n\nexport function elementHasAncestorTag(\n  el: HTMLElement,\n  tagName: string\n): boolean {\n  const parentElement = el.parentElement;\n  if (!parentElement) {\n    return false;\n  }\n  if (parentElement.tagName === tagName.toUpperCase()) {\n    return true;\n  }\n  return elementHasAncestorTag(parentElement, tagName);\n}\n\nexport function sanitizeStyle(style: string) {\n  const purifiedOuterHTML = DOMPurify.sanitize(`<style>${style}</style>`, {\n    ALLOWED_TAGS: ['style'],\n    ALLOWED_ATTR: [],\n    FORCE_BODY: true,\n  });\n  const wrapperEl = document.createElement('div');\n  // deepcode ignore ReactSetInnerHtml: sanitized by dompurify\n  wrapperEl.innerHTML = purifiedOuterHTML;\n  return wrapperEl.querySelector('style')?.innerHTML;\n}\n\nexport function getFocusedElement(\n  rootElement: Document | ShadowRoot = document\n): Element | null {\n  const activeElement = rootElement.activeElement;\n  if (activeElement?.shadowRoot) {\n    return getFocusedElement(activeElement.shadowRoot) ?? activeElement;\n  }\n  return activeElement;\n}\n\nexport function isFocusingOut(event: FocusEvent) {\n  return (\n    document.hasFocus() &&\n    (!(event.relatedTarget instanceof Node) ||\n      (event.currentTarget instanceof Node &&\n        !event.currentTarget.contains(event.relatedTarget)))\n  );\n}\n\n// https://terodox.tech/how-to-tell-if-an-element-is-in-the-dom-including-the-shadow-dom/\nexport function isInDocument(element: Node) {\n  let currentElement = element;\n  while (currentElement?.parentNode) {\n    if (currentElement.parentNode === document) {\n      return true;\n    } else if (currentElement.parentNode instanceof ShadowRoot) {\n      currentElement = currentElement.parentNode.host;\n    } else {\n      currentElement = currentElement.parentNode;\n    }\n  }\n  return false;\n}\n\nexport function isPropValuesEqual<ObjectWithProperties extends object>(\n  subject: ObjectWithProperties,\n  target: ObjectWithProperties,\n  propNames: (keyof ObjectWithProperties)[]\n) {\n  return propNames.every((propName) => subject[propName] === target[propName]);\n}\n\nexport function getParent(element: Element | ShadowRoot) {\n  if (element.parentNode) {\n    return element.parentNode as Element | ShadowRoot;\n  }\n  if (element instanceof ShadowRoot) {\n    return element.host;\n  }\n  return null;\n}\n\nexport function isAncestorOf(\n  ancestor: Element | ShadowRoot,\n  element: Element | ShadowRoot\n): boolean {\n  if (element === ancestor) {\n    return true;\n  }\n  if (\n    element instanceof HTMLElement &&\n    element.assignedSlot &&\n    isAncestorOf(ancestor, element.assignedSlot)\n  ) {\n    return true;\n  }\n  const parent = getParent(element);\n  return parent === null ? false : isAncestorOf(ancestor, parent);\n}\n\nexport function aggregate<V, K extends PropertyKey>(\n  values: readonly V[],\n  getKey: (value: V, index: number) => K\n): Record<K, V[] | undefined> {\n  return values.reduce(\n    (aggregatedValues, value, i) => {\n      const key = getKey(value, i);\n      if (!(key in aggregatedValues)) {\n        aggregatedValues[key] = [];\n      }\n      aggregatedValues[key]!.push(value);\n      return aggregatedValues;\n    },\n    <Record<K, V[] | undefined>>{}\n  );\n}\n\n/**\n * Similar as a classic spread, but preserve all characteristics of properties (e.g. getter/setter).\n * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign#description\n * for an explanation why (spread & assign work similarly).\n * @param objects the objects to \"spread\" together\n * @returns the spread result\n */\nexport function spreadProperties<Output extends object = {}>(\n  ...objects: object[]\n) {\n  const returnObject = {};\n  for (const obj of objects) {\n    Object.defineProperties(\n      returnObject,\n      Object.getOwnPropertyDescriptors(obj)\n    );\n  }\n  return returnObject as Output;\n}\n\nexport const sortByDocumentPosition = (a: Node, b: Node): 1 | -1 =>\n  a.compareDocumentPosition(b) & Node.DOCUMENT_POSITION_FOLLOWING ? -1 : 1;\n\nexport async function defer() {\n  return new Promise<void>((resolve) => setTimeout(resolve, 10));\n}\n"],"version":3}

package/dist/types/components/insight/result-templates/atomic-insight-result-children/atomic-insight-result-children.d.ts

@@ -1,44 +0,0 @@
-import { InitializableComponent } from '../../../../utils/initialization-utils';
-import { ResultTemplateProvider } from '../../../common/item-list/result-template-provider';
-import { ChildTemplatesContextEvent } from '../../../common/item-list/stencil-item-decorators';
-import { ItemDisplayImageSize } from '../../../common/layout/display-options';
-import { InsightBindings } from '../../atomic-insight-interface/atomic-insight-interface';
-/**
- * @internal
- */
-export declare class AtomicResultChildren implements InitializableComponent<InsightBindings> {
-    bindings: InsightBindings;
-    itemTemplateProvider?: ResultTemplateProvider;
-    private foldedResultList;
-    private result;
-    private displayConfig;
-    private initialChildren;
-    host: HTMLDivElement;
-    error: Error;
-    private resultTemplateRegistered;
-    private templateHasError;
-    private foldedResultListState;
-    private showInitialChildren;
-    /**
-     * Whether to inherit templates defined in a parent atomic-result-children. Only works for the second level of child nesting.
-     */
-    inheritTemplates: boolean;
-    /**
-     * The expected size of the image displayed in the children results.
-     */
-    imageSize?: ItemDisplayImageSize;
-    /**
-     * The non-localized copy for an empty result state. An empty string will result in the component being hidden.
-     */
-    noResultText: string;
-    resolveChildTemplates(event: ChildTemplatesContextEvent): void;
-    initialize(): void;
-    private renderChild;
-    componentWillRender(): void;
-    private get collection();
-    private loadFullCollection;
-    private toggleShowInitialChildren;
-    private renderCollection;
-    private renderFoldedResult;
-    render(): any;
-}