@coveo/atomic 3.33.8-pre.a2a2959a46 → 3.33.8-pre.a42c491ac0

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-09-25T15:42:38",
+  "timestamp": "2025-09-29T18:57:52",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -9351,15 +9351,15 @@
       "props": [
         {
           "name": "bindings",
-          "type": "CommonBindings<SearchEngine<{}>, SearchStore, AtomicSearchInterface> & NonceBindings",
+          "type": "CommonBindings<SearchEngine<{}>, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings",
           "complexType": {
             "original": "Bindings",
-            "resolved": "CommonBindings<SearchEngine<{}>, SearchStore, AtomicSearchInterface> & NonceBindings",
+            "resolved": "CommonBindings<SearchEngine<{}>, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings",
             "references": {
               "Bindings": {
                 "location": "import",
                 "path": "../atomic-search-interface/atomic-search-interface",
-                "id": "src/components/search/atomic-search-interface/atomic-search-interface.ts::Bindings"
+                "id": "src/components/search/atomic-search-interface/atomic-search-interface.tsx::Bindings"
               }
             }
           },
@@ -9369,7 +9369,7 @@
           "docsTags": [],
           "values": [
             {
-              "type": "CommonBindings<SearchEngine<{}>, SearchStore, AtomicSearchInterface> & NonceBindings"
+              "type": "CommonBindings<SearchEngine<{}>, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings"
             }
           ],
           "optional": false,
@@ -9419,9 +9419,15 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [],
+      "dependents": [
+        "atomic-search-interface"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "atomic-search-interface": [
+          "atomic-relevance-inspector"
+        ]
+      }
     },
     {
       "filePath": "src/components/search/atomic-result/atomic-result.tsx",
@@ -12894,6 +12900,543 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/search/atomic-search-interface/atomic-search-interface.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-search-interface",
+      "docs": "The `atomic-search-interface` component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "CspNonce",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "csp-nonce",
+          "reflectToAttr": true,
+          "docs": "The value to set the [nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) attribute to on inline script and style elements generated by this interface and its child components.\nIf your application is served with a Content Security Policy (CSP) that doesn't include the `script-src: 'unsafe-inline'` or `style-src: 'unsafe-inline'` directives,\nyou should ensure that your application server generates a new nonce on every page load and uses the generated value to set this prop and serve the corresponding CSP response headers\n(i.e., script-src 'nonce-<YOUR_GENERATED_NONCE>' and style-src 'nonce-<YOUR_GENERATED_NONCE>').\nOtherwise you may see console errors such as\n - Refused to execute inline script because it violates the following Content Security Policy directive: [...]\n - Refused to apply inline style because it violates the following Content Security Policy directive: [...].",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": ":\n```html\n<script nonce=\"<YOUR_GENERATED_NONCE>\">\nimport {setNonce} from '@coveo/atomic';\nsetNonce('<YOUR_GENERATED_NONCE>');\n</script>\n```"
+            }
+          ],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "analytics",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "analytics",
+          "reflectToAttr": true,
+          "docs": "Whether analytics should be enabled.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "enableRelevanceInspector",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "enable-relevance-inspector",
+          "reflectToAttr": true,
+          "docs": "Whether the relevance inspector shortcut should be enabled for this interface.\n\nThe relevance inspector can be opened by holding the Alt key (Option on Mac) while over the interface, and performing a double click.\n\nThe relevance inspector allows to troubleshoot and debug queries.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "engine",
+          "type": "SearchEngine<{}> | undefined",
+          "complexType": {
+            "original": "SearchEngine",
+            "resolved": "SearchEngine<{}> | undefined",
+            "references": {
+              "SearchEngine": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::SearchEngine"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The search interface headless engine.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "SearchEngine<{}>"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "fieldsToInclude",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "fields-to-include",
+          "reflectToAttr": false,
+          "docs": "A list of non-default fields to include in the query results.\n\nSpecify the property as an array using a JSON string representation:\n```html\n<atomic-search-interface fields-to-include='[\"fieldA\", \"fieldB\"]'></atomic-search-interface>\n```",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "i18n",
+          "type": "i18n",
+          "complexType": {
+            "original": "i18n",
+            "resolved": "i18n",
+            "references": {
+              "i18n": {
+                "location": "import",
+                "path": "i18next",
+                "id": "../../node_modules/i18next/index.d.mts::i18n"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The search interface i18next instance.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "i18n"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "iconAssetsPath",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "icon-assets-path",
+          "reflectToAttr": true,
+          "docs": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"",
+          "docsTags": [],
+          "default": "'./assets'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "language",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "language",
+          "reflectToAttr": true,
+          "docs": "The search interface language.",
+          "docsTags": [],
+          "default": "'en'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "languageAssetsPath",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "language-assets-path",
+          "reflectToAttr": true,
+          "docs": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"",
+          "docsTags": [],
+          "default": "'./lang'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "logLevel",
+          "type": "\"debug\" | \"error\" | \"fatal\" | \"info\" | \"silent\" | \"trace\" | \"warn\" | undefined",
+          "complexType": {
+            "original": "LogLevel",
+            "resolved": "\"debug\" | \"error\" | \"fatal\" | \"info\" | \"silent\" | \"trace\" | \"warn\" | undefined",
+            "references": {
+              "LogLevel": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::LogLevel"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "log-level",
+          "reflectToAttr": true,
+          "docs": "The severity level of the messages to log in the console.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "debug",
+              "type": "string"
+            },
+            {
+              "value": "error",
+              "type": "string"
+            },
+            {
+              "value": "fatal",
+              "type": "string"
+            },
+            {
+              "value": "info",
+              "type": "string"
+            },
+            {
+              "value": "silent",
+              "type": "string"
+            },
+            {
+              "value": "trace",
+              "type": "string"
+            },
+            {
+              "value": "warn",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "pipeline",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "pipeline",
+          "reflectToAttr": true,
+          "docs": "The search interface [query pipeline](https://docs.coveo.com/en/180/).\n\nIf the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine), the query pipeline should instead be configured in the target engine.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "reflectStateInUrl",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "reflect-state-in-url",
+          "reflectToAttr": true,
+          "docs": "Whether the state should be reflected in the URL parameters.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "scrollContainer",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "scroll-container",
+          "reflectToAttr": true,
+          "docs": "The CSS selector for the container where the interface will scroll back to.",
+          "docsTags": [],
+          "default": "'atomic-search-interface'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "searchHub",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "search-hub",
+          "reflectToAttr": true,
+          "docs": "The search interface [search hub](https://docs.coveo.com/en/1342/).\n\nIf the search interface is initialized using [`initializeWithSearchEngine`](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-search-interface/#initializewithsearchengine, the search hub should instead be configured in the target engine.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "timezone",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "timezone",
+          "reflectToAttr": true,
+          "docs": "The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression, facets, and result items.\nBy default, the timezone will be [guessed](https://day.js.org/docs/en/timezone/guessing-user-timezone).\n\nExample: \"America/Montreal\"",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "executeFirstSearch",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "StandaloneSearchBoxData": {
+                "location": "import",
+                "path": "../../../utils/local-storage-utils",
+                "id": "src/utils/local-storage-utils.ts::StandaloneSearchBoxData"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "executeFirstSearch() => Promise<void>",
+          "parameters": [],
+          "docs": "\nExecutes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine.",
+          "docsTags": []
+        },
+        {
+          "name": "initialize",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(options: InitializationOptions) => Promise<void>",
+            "parameters": [
+              {
+                "name": "options",
+                "type": "SearchEngineConfiguration",
+                "docs": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "InitializationOptions": {
+                "location": "local",
+                "path": "/home/runner/work/ui-kit/ui-kit/packages/atomic/src/components/search/atomic-search-interface/atomic-search-interface.tsx",
+                "id": "src/components/search/atomic-search-interface/atomic-search-interface.tsx::InitializationOptions"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "initialize(options: InitializationOptions) => Promise<void>",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "SearchEngineConfiguration",
+              "docs": ""
+            }
+          ],
+          "docs": "Initializes the connection with the headless search engine using options for `accessToken` (required), `organizationId` (required), `environment` (defaults to `prod`), and `renewAccessToken`.",
+          "docsTags": []
+        },
+        {
+          "name": "initializeWithSearchEngine",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(engine: SearchEngine) => Promise<void>",
+            "parameters": [
+              {
+                "name": "engine",
+                "type": "SearchEngine<{}>",
+                "docs": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "SearchEngine": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::SearchEngine"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "initializeWithSearchEngine(engine: SearchEngine) => Promise<void>",
+          "parameters": [
+            {
+              "name": "engine",
+              "type": "SearchEngine<{}>",
+              "docs": ""
+            }
+          ],
+          "docs": "Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.SearchEngine.html), as opposed to the `initialize` method, which will internally create a new search engine instance.\nThis bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.",
+          "docsTags": []
+        }
+      ],
+      "events": [],
+      "listeners": [
+        {
+          "event": "atomic/initializeComponent",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "atomic/scrollToTop",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "atomic/relevanceInspector/close",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "atomic-relevance-inspector"
+      ],
+      "dependencyGraph": {
+        "atomic-search-interface": [
+          "atomic-relevance-inspector"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/facets/atomic-segmented-facet/atomic-segmented-facet.tsx",
       "encapsulation": "shadow",
@@ -15451,16 +15994,36 @@
     }
   ],
   "typeLibrary": {
-    "../headless/dist/definitions/insight.index.d.ts::InsightEngine": {
+    "../headless/dist/definitions/index.d.ts::LogLevel": {
       "declaration": "any",
       "docstring": "",
-      "path": "../headless/dist/definitions/insight.index.d.ts"
+      "path": "../headless/dist/definitions/index.d.ts"
     },
     "../../node_modules/i18next/index.d.mts::i18n": {
       "declaration": "export interface i18n extends i18nextMod.i18n, CustomInstanceExtensions {}",
       "docstring": "",
       "path": "../../node_modules/i18next/index.d.mts"
     },
+    "../headless/dist/definitions/index.d.ts::SearchEngine": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../headless/dist/definitions/index.d.ts"
+    },
+    "src/components/search/atomic-search-interface/atomic-search-interface.tsx::InitializationOptions": {
+      "declaration": "export interface SearchEngineConfiguration extends EngineConfiguration {\n    /**\n     * The global headless engine configuration options specific to the SearchAPI.\n     */\n    search?: SearchConfigurationOptions;\n}",
+      "docstring": "The search engine configuration.",
+      "path": "src/components/search/atomic-search-interface/atomic-search-interface.tsx"
+    },
+    "src/utils/local-storage-utils.ts::StandaloneSearchBoxData": {
+      "declaration": "export interface StandaloneSearchBoxData {\n  value: string;\n  enableQuerySyntax?: boolean;\n  analytics: StandaloneSearchBoxAnalytics;\n}",
+      "docstring": "",
+      "path": "src/utils/local-storage-utils.ts"
+    },
+    "../headless/dist/definitions/insight.index.d.ts::InsightEngine": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../headless/dist/definitions/insight.index.d.ts"
+    },
     "../headless/dist/definitions/insight.index.d.ts::LogLevel": {
       "declaration": "any",
       "docstring": "",
@@ -15526,10 +16089,10 @@
       "docstring": "",
       "path": "src/components/common/layout/display-options.ts"
     },
-    "src/components/common/suggestions/suggestions-common.ts::SearchBoxSuggestionElement": {
+    "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-common.ts"
+      "path": "src/components/common/suggestions/suggestions-types.ts"
     },
     "../headless/dist/definitions/index.d.ts::RelativeDateUnit": {
       "declaration": "any",
@@ -15691,10 +16254,10 @@
       "docstring": "",
       "path": "src/utils/initialization-utils.tsx"
     },
-    "src/components/search/atomic-search-interface/atomic-search-interface.ts::Bindings": {
-      "declaration": "export type Bindings = CommonBindings<\n  SearchEngine,\n  SearchStore,\n  AtomicSearchInterface\n> &\n  //TODO: KIT-4893 - Remove once atomic-quickview-modal migration is complete.\n  NonceBindings;",
+    "src/components/search/atomic-search-interface/atomic-search-interface.tsx::Bindings": {
+      "declaration": "export type Bindings = CommonBindings<\n  SearchEngine,\n  SearchStore,\n  HTMLAtomicSearchInterfaceElement\n> &\n  NonceBindings;",
       "docstring": "",
-      "path": "src/components/search/atomic-search-interface/atomic-search-interface.ts"
+      "path": "src/components/search/atomic-search-interface/atomic-search-interface.tsx"
     },
     "../headless/dist/definitions/index.d.ts::FoldedResult": {
       "declaration": "any",