@coveo/atomic 3.47.1 → 3.49.0

package/docs/atomic-docs.json

@@ -1,684 +1,11 @@
 {
-  "timestamp": "2026-02-04T03:58:11",
+  "timestamp": "2026-02-18T03:07:41",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
     "typescriptVersion": "5.5.3"
   },
-  "components": [
-    {
-      "filePath": "src/components/common/generated-answer/atomic-generated-answer-feedback/atomic-generated-answer-feedback-modal.tsx",
-      "encapsulation": "shadow",
-      "tag": "atomic-generated-answer-feedback-modal",
-      "docs": "Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "generatedAnswer",
-          "type": "GeneratedAnswer",
-          "complexType": {
-            "original": "GeneratedAnswer",
-            "resolved": "GeneratedAnswer",
-            "references": {
-              "GeneratedAnswer": {
-                "location": "import",
-                "path": "@coveo/headless",
-                "id": "../headless/dist/definitions/index.d.ts::GeneratedAnswer"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "A `GeneratedAnswer` controller instance. It is used when the user interacts with the modal.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "GeneratedAnswer"
-            }
-          ],
-          "optional": false,
-          "required": true
-        },
-        {
-          "name": "helpful",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "helpful",
-          "reflectToAttr": true,
-          "docs": "Indicates whether the answer was helpful or not.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "isOpen",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "is-open",
-          "reflectToAttr": true,
-          "docs": "Indicates whether the modal is open.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "feedbackSent",
-          "detail": "any",
-          "bubbles": true,
-          "complexType": {
-            "original": "any",
-            "resolved": "any",
-            "references": {}
-          },
-          "cancelable": true,
-          "composed": true,
-          "docs": "",
-          "docsTags": [
-            {
-              "name": "migration",
-              "text": "Stencil's"
-            },
-            {
-              "name": "Event",
-              "text": "() decorator defaults to: bubbles=true, composed=true, cancelable=true.\nNative CustomEvent defaults to: bubbles=false, composed=false, cancelable=false.\nWhen migrating to Lit, explicitly set all three options to preserve behavior:\n`new CustomEvent('feedbackSent', { bubbles: true, composed: true, cancelable: true })`"
-            }
-          ]
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [
-        {
-          "name": "cancel-button",
-          "docs": ""
-        },
-        {
-          "name": "form",
-          "docs": ""
-        },
-        {
-          "name": "generated-answer-feedback-modal",
-          "docs": ""
-        },
-        {
-          "name": "modal-footer",
-          "docs": ""
-        },
-        {
-          "name": "modal-header",
-          "docs": ""
-        },
-        {
-          "name": "submit-button",
-          "docs": ""
-        }
-      ],
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
-    },
-    {
-      "filePath": "src/components/insight/user-actions/atomic-insight-user-actions-timeline/atomic-insight-user-actions-timeline.tsx",
-      "encapsulation": "shadow",
-      "tag": "atomic-insight-user-actions-timeline",
-      "docs": "Internal component used by the `atomic-insight-user-actions-modal`. Do not use directly.\n\nThis component displays all the actions performed by a user around the time they created a case.\nThe actions are grouped into multiple sessions, including the session during which the case was created,\nthe sessions preceding the case creation and the sessions following the case creation.",
-      "docsTags": [
-        {
-          "name": "component"
-        },
-        {
-          "name": "example",
-          "text": "<AtomicInsightUserActionsTimeline userId={'123'} caseCreationDate={'2024-08-15T10:00:00Z'} />"
-        }
-      ],
-      "usage": {},
-      "props": [
-        {
-          "name": "excludedCustomActions",
-          "type": "string[]",
-          "complexType": {
-            "original": "string[]",
-            "resolved": "string[]",
-            "references": {}
-          },
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The names of custom events to exclude.",
-          "docsTags": [],
-          "default": "[]",
-          "values": [
-            {
-              "type": "string[]"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "ticketCreationDateTime",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "ticket-creation-date-time",
-          "reflectToAttr": false,
-          "docs": "The date and time when the case was created. For example \"2024-01-01T00:00:00Z\"",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": true
-        },
-        {
-          "name": "userId",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "user-id",
-          "reflectToAttr": false,
-          "docs": "The ID of the user whose actions are being displayed. For example in email format \"someone@company.com\".",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": true
-        }
-      ],
-      "methods": [],
-      "events": [],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [
-        {
-          "name": "toggle-following-sessions",
-          "docs": ""
-        },
-        {
-          "name": "toggle-following-sessions-icon",
-          "docs": ""
-        },
-        {
-          "name": "toggle-preceding-sessions",
-          "docs": ""
-        },
-        {
-          "name": "toggle-preceding-sessions-icon",
-          "docs": ""
-        }
-      ],
-      "dependents": [
-        "atomic-insight-user-actions-modal"
-      ],
-      "dependencies": [
-        "atomic-insight-user-actions-session"
-      ],
-      "dependencyGraph": {
-        "atomic-insight-user-actions-timeline": [
-          "atomic-insight-user-actions-session"
-        ],
-        "atomic-insight-user-actions-modal": [
-          "atomic-insight-user-actions-timeline"
-        ]
-      }
-    },
-    {
-      "filePath": "src/components/recommendations/atomic-recs-list/atomic-recs-list.tsx",
-      "encapsulation": "shadow",
-      "tag": "atomic-recs-list",
-      "docs": "The `atomic-recs-list` component displays recommendations by applying one or more result templates.",
-      "docsTags": [
-        {
-          "name": "part",
-          "text": "result-list - The element containing the list of results."
-        },
-        {
-          "name": "part",
-          "text": "result-list-grid-clickable-container - The parent of the result and the clickable link encompassing it."
-        },
-        {
-          "name": "part",
-          "text": "result-list-grid-clickable - The clickable link encompassing the result."
-        },
-        {
-          "name": "part",
-          "text": "label - The label of the result list."
-        },
-        {
-          "name": "part",
-          "text": "previous-button - The previous button."
-        },
-        {
-          "name": "part",
-          "text": "next-button - The next button."
-        },
-        {
-          "name": "part",
-          "text": "indicators - The list of indicators."
-        },
-        {
-          "name": "part",
-          "text": "indicator - A single indicator."
-        },
-        {
-          "name": "part",
-          "text": "active-indicator - The active indicator."
-        },
-        {
-          "name": "slot",
-          "text": "default - The default slot where to insert the template element."
-        }
-      ],
-      "usage": {},
-      "props": [
-        {
-          "name": "density",
-          "type": "\"comfortable\" | \"compact\" | \"normal\"",
-          "complexType": {
-            "original": "ItemDisplayDensity",
-            "resolved": "\"comfortable\" | \"compact\" | \"normal\"",
-            "references": {
-              "ItemDisplayDensity": {
-                "location": "import",
-                "path": "../../common/layout/display-options",
-                "id": "src/components/common/layout/display-options.ts::ItemDisplayDensity"
-              }
-            }
-          },
-          "mutable": false,
-          "attr": "density",
-          "reflectToAttr": true,
-          "docs": "The spacing of various elements in the result list, including the gap between results, the gap between parts of a result, and the font sizes of different parts in a result.",
-          "docsTags": [],
-          "default": "'normal'",
-          "values": [
-            {
-              "value": "comfortable",
-              "type": "string"
-            },
-            {
-              "value": "compact",
-              "type": "string"
-            },
-            {
-              "value": "normal",
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "display",
-          "type": "\"grid\" | \"list\"",
-          "complexType": {
-            "original": "ItemDisplayBasicLayout",
-            "resolved": "\"grid\" | \"list\"",
-            "references": {
-              "ItemDisplayBasicLayout": {
-                "location": "import",
-                "path": "../../common/layout/display-options",
-                "id": "src/components/common/layout/display-options.ts::ItemDisplayBasicLayout"
-              }
-            }
-          },
-          "mutable": false,
-          "attr": "display",
-          "reflectToAttr": true,
-          "docs": "The layout to apply when displaying results themselves. This does not affect the display of the surrounding list itself.\nTo modify the number of recommendations per column, modify the --atomic-recs-number-of-columns CSS variable.",
-          "docsTags": [],
-          "default": "'list'",
-          "values": [
-            {
-              "value": "grid",
-              "type": "string"
-            },
-            {
-              "value": "list",
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "headingLevel",
-          "type": "number",
-          "complexType": {
-            "original": "number",
-            "resolved": "number",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "heading-level",
-          "reflectToAttr": true,
-          "docs": "The [heading level](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements) to use for the heading label, from 1 to 6.",
-          "docsTags": [],
-          "default": "0",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "imageSize",
-          "type": "\"icon\" | \"large\" | \"none\" | \"small\"",
-          "complexType": {
-            "original": "ItemDisplayImageSize",
-            "resolved": "\"icon\" | \"large\" | \"none\" | \"small\"",
-            "references": {
-              "ItemDisplayImageSize": {
-                "location": "import",
-                "path": "../../common/layout/display-options",
-                "id": "src/components/common/layout/display-options.ts::ItemDisplayImageSize"
-              }
-            }
-          },
-          "mutable": false,
-          "attr": "image-size",
-          "reflectToAttr": true,
-          "docs": "The expected size of the image displayed in the results.",
-          "docsTags": [],
-          "default": "'small'",
-          "values": [
-            {
-              "value": "icon",
-              "type": "string"
-            },
-            {
-              "value": "large",
-              "type": "string"
-            },
-            {
-              "value": "none",
-              "type": "string"
-            },
-            {
-              "value": "small",
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "label",
-          "type": "string | undefined",
-          "complexType": {
-            "original": "string",
-            "resolved": "string | undefined",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "label",
-          "reflectToAttr": true,
-          "docs": "The non-localized label for the list of recommendations.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "undefined"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "numberOfRecommendations",
-          "type": "number",
-          "complexType": {
-            "original": "number",
-            "resolved": "number",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "number-of-recommendations",
-          "reflectToAttr": true,
-          "docs": "The total number of recommendations to display.\nThis does not modify the number of recommendations per column. To do so, modify the --atomic-recs-number-of-columns CSS variable.",
-          "docsTags": [],
-          "default": "10",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "numberOfRecommendationsPerPage",
-          "type": "number | undefined",
-          "complexType": {
-            "original": "number",
-            "resolved": "number | undefined",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "number-of-recommendations-per-page",
-          "reflectToAttr": true,
-          "docs": "The number of recommendations to display, per page.\nSetting a value greater than and lower than the numberOfRecommendations value activates the carousel.\nThis does not affect the display of the list itself, only the number of recommendation pages.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "number"
-            },
-            {
-              "type": "undefined"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "recommendation",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "recommendation",
-          "reflectToAttr": true,
-          "docs": "The Recommendation identifier used by the Coveo platform to retrieve recommended documents.\nMake sure to set a different value for each atomic-recs-list in your page.",
-          "docsTags": [],
-          "default": "'Recommendation'",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [
-        {
-          "name": "nextPage",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "() => Promise<void>",
-            "parameters": [],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              }
-            },
-            "return": "Promise<void>"
-          },
-          "signature": "nextPage() => Promise<void>",
-          "parameters": [],
-          "docs": "Moves to the next page, when the carousel is activated.",
-          "docsTags": []
-        },
-        {
-          "name": "previousPage",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "() => Promise<void>",
-            "parameters": [],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              }
-            },
-            "return": "Promise<void>"
-          },
-          "signature": "previousPage() => Promise<void>",
-          "parameters": [],
-          "docs": "Moves to the previous page, when the carousel is activated.",
-          "docsTags": []
-        },
-        {
-          "name": "setRenderFunction",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(resultRenderingFunction: ItemRenderingFunction) => Promise<void>",
-            "parameters": [
-              {
-                "name": "resultRenderingFunction",
-                "type": "((result: AnyItem, root: HTMLElement, linkContainer?: HTMLElement | undefined) => string) | undefined",
-                "docs": ""
-              }
-            ],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              },
-              "ItemRenderingFunction": {
-                "location": "import",
-                "path": "../../common/item-list/stencil-item-list-common",
-                "id": "src/components/common/item-list/stencil-item-list-common.tsx::ItemRenderingFunction"
-              }
-            },
-            "return": "Promise<void>"
-          },
-          "signature": "setRenderFunction(resultRenderingFunction: ItemRenderingFunction) => Promise<void>",
-          "parameters": [
-            {
-              "name": "resultRenderingFunction",
-              "type": "((result: AnyItem, root: HTMLElement, linkContainer?: HTMLElement | undefined) => string) | undefined",
-              "docs": ""
-            }
-          ],
-          "docs": "Sets a rendering function to bypass the standard HTML template mechanism for rendering results.\nYou can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.\n\nDo not use this method if you integrate Atomic in a plain HTML deployment.",
-          "docsTags": [
-            {
-              "name": "param",
-              "text": "resultRenderingFunction"
-            }
-          ]
-        }
-      ],
-      "events": [],
-      "listeners": [],
-      "styles": [],
-      "slots": [
-        {
-          "name": "default",
-          "docs": "The default slot where to insert the template element."
-        }
-      ],
-      "parts": [
-        {
-          "name": "active-indicator",
-          "docs": "The active indicator."
-        },
-        {
-          "name": "indicator",
-          "docs": "A single indicator."
-        },
-        {
-          "name": "indicators",
-          "docs": "The list of indicators."
-        },
-        {
-          "name": "label",
-          "docs": "The label of the result list."
-        },
-        {
-          "name": "next-button",
-          "docs": "The next button."
-        },
-        {
-          "name": "previous-button",
-          "docs": "The previous button."
-        },
-        {
-          "name": "result-list",
-          "docs": "The element containing the list of results."
-        },
-        {
-          "name": "result-list-grid-clickable",
-          "docs": "The clickable link encompassing the result."
-        },
-        {
-          "name": "result-list-grid-clickable-container",
-          "docs": "The parent of the result and the clickable link encompassing it."
-        }
-      ],
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
-    }
-  ],
+  "components": [],
   "typeLibrary": {
     "src/components/insight/atomic-insight-result-action/atomic-insight-result-action.tsx::Actions": {
       "declaration": "export enum Actions {\n  CopyToClipboard = 'copyToClipboard',\n  AttachToCase = 'attachToCase',\n  Quickview = 'quickview',\n  PostToFeed = 'postToFeed',\n  SendAsEmail = 'sendAsEmail',\n}",
@@ -695,16 +22,6 @@
       "docstring": "",
       "path": "src/components/insight/atomic-insight-result-attach-to-case-action/atomic-insight-result-attach-to-case-action.tsx"
     },
-    "../../node_modules/.pnpm/i18next@25.3.2_typescript@5.8.3/node_modules/i18next/index.d.mts::i18n": {
-      "declaration": "export interface i18n extends i18nextMod.i18n, CustomInstanceExtensions {}",
-      "docstring": "",
-      "path": "../../node_modules/.pnpm/i18next@25.3.2_typescript@5.8.3/node_modules/i18next/index.d.mts"
-    },
-    "src/components/common/suggestions/suggestions-types.ts::SearchBoxSuggestionElement": {
-      "declaration": "export interface SearchBoxSuggestionElement {\n  /**\n   * Stable identity which enables Stencil to reuse DOM elements for better performance.\n   * The best way to pick a key is to use a string that uniquely identifies that list item among its siblings (often your data will already have IDs).\n   */\n  key: string;\n  /**\n   * Rendered content of the element.\n   *\n   * @remarks\n   * The `VNode` type will be deprecated in v4 as we are detaching from Stencil.\n   */\n  content: Element | VNode;\n  /**\n   * Hook called when the selection is selected.\n   * @param e DOM event.\n   */\n  onSelect?(e: Event): void;\n  /**\n   * The query associated with the suggestion which will replace the query in the search box if the suggestion is selected.\n   */\n  query?: string;\n  /**\n   * For improved accessibility, provide this property with additional information.\n   * https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label\n   */\n  ariaLabel?: string;\n  /**\n   * Adds a specific shadow part attribute that can be selected with the CSS ::part pseudo-element.\n   * https://developer.mozilla.org/en-US/docs/Web/CSS/::part\n   */\n  part?: string;\n  /**\n   * Hide the suggestion if it's the last in the list.\n   */\n  hideIfLast?: boolean;\n}",
-      "docstring": "Element which will be rendered in the list of suggestions.",
-      "path": "src/components/common/suggestions/suggestions-types.ts"
-    },
     "src/components/common/interface/bindings.ts::AnyBindings": {
       "declaration": "export interface CommonBindings<\n  Engine extends AnyEngineType,\n  Store extends AnyStore,\n  InterfaceElement extends HTMLElement,\n> {\n  /**\n   * A headless engine instance.\n   */\n  engine: Engine;\n  /**\n   * i18n instance, for localization.\n   */\n  i18n: i18n;\n  /**\n   * Global state for Atomic\n   */\n  store: Store;\n  /**\n   * A reference to the atomic interface element.\n   */\n  interfaceElement: InterfaceElement;\n}",
       "docstring": "Bindings passed from an interface to its children components.",
@@ -720,15 +37,25 @@
       "docstring": "",
       "path": "../headless/dist/definitions/index.d.ts"
     },
-    "../headless/dist/definitions/index.d.ts::GeneratedAnswer": {
+    "../headless/dist/definitions/insight.index.d.ts::RangeFacetSortCriterion": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../headless/dist/definitions/insight.index.d.ts"
+    },
+    "../headless/dist/definitions/index.d.ts::ResultTemplateCondition": {
       "declaration": "any",
       "docstring": "",
       "path": "../headless/dist/definitions/index.d.ts"
     },
-    "../headless/dist/definitions/insight.index.d.ts::RangeFacetSortCriterion": {
+    "../headless/dist/definitions/index.d.ts::ResultTemplate": {
       "declaration": "any",
       "docstring": "",
-      "path": "../headless/dist/definitions/insight.index.d.ts"
+      "path": "../headless/dist/definitions/index.d.ts"
+    },
+    "src/components/common/layout/display-options.ts::ItemDisplayBasicLayout": {
+      "declaration": "export type ItemDisplayBasicLayout = 'list' | 'grid';",
+      "docstring": "",
+      "path": "src/components/common/layout/display-options.ts"
     },
     "src/components/common/layout/display-options.ts::ItemDisplayDensity": {
       "declaration": "export type ItemDisplayDensity = 'comfortable' | 'normal' | 'compact';",
@@ -744,26 +71,6 @@
       "declaration": "export type ItemRenderingFunction<SpecificResult extends AnyItem = AnyItem> =\n  | ((\n      result: SpecificResult,\n      root: HTMLElement,\n      linkContainer?: HTMLElement\n    ) => string)\n  | undefined;",
       "docstring": "",
       "path": "src/components/common/item-list/stencil-item-list-common.tsx"
-    },
-    "../headless/dist/definitions/index.d.ts::ResultTemplateCondition": {
-      "declaration": "any",
-      "docstring": "",
-      "path": "../headless/dist/definitions/index.d.ts"
-    },
-    "../headless/dist/definitions/index.d.ts::ResultTemplate": {
-      "declaration": "any",
-      "docstring": "",
-      "path": "../headless/dist/definitions/index.d.ts"
-    },
-    "../headless/dist/definitions/insight.index.d.ts::UserAction": {
-      "declaration": "any",
-      "docstring": "",
-      "path": "../headless/dist/definitions/insight.index.d.ts"
-    },
-    "src/components/common/layout/display-options.ts::ItemDisplayBasicLayout": {
-      "declaration": "export type ItemDisplayBasicLayout = 'list' | 'grid';",
-      "docstring": "",
-      "path": "src/components/common/layout/display-options.ts"
     }
   }
 }