@coveo/atomic 3.33.8-pre.1453f4a29f → 3.33.8-pre.166c023bc3

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-09-29T15:59:36",
+  "timestamp": "2025-09-30T20:23:24",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -9341,6 +9341,94 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/search/atomic-relevance-inspector/atomic-relevance-inspector.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-relevance-inspector",
+      "docs": "The `atomic-relevance-inspector` component is used internally to offer insight on search page relevance, as well as information to help troubleshoot issues during development.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "bindings",
+          "type": "CommonBindings<SearchEngine<{}>, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings",
+          "complexType": {
+            "original": "Bindings",
+            "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.tsx::Bindings"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The Atomic interface bindings, namely the headless search engine and i18n instances.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "CommonBindings<SearchEngine<{}>, SearchStore, HTMLAtomicSearchInterfaceElement> & NonceBindings"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "open",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "open",
+          "reflectToAttr": true,
+          "docs": "",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "atomic/relevanceInspector/close",
+          "detail": "any",
+          "bubbles": true,
+          "complexType": {
+            "original": "any",
+            "resolved": "any",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-search-interface"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-search-interface": [
+          "atomic-relevance-inspector"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/atomic-result/atomic-result.tsx",
       "encapsulation": "shadow",
@@ -12392,14 +12480,12 @@
       "dependents": [],
       "dependencies": [
         "atomic-suggestion-renderer",
-        "atomic-search-box-recent-queries",
-        "atomic-search-box-query-suggestions"
+        "atomic-search-box-recent-queries"
       ],
       "dependencyGraph": {
         "atomic-search-box": [
           "atomic-suggestion-renderer",
-          "atomic-search-box-recent-queries",
-          "atomic-search-box-query-suggestions"
+          "atomic-search-box-recent-queries"
         ]
       }
     },
@@ -12621,10 +12707,10 @@
       }
     },
     {
-      "filePath": "src/components/search/search-box-suggestions/atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.tsx",
+      "filePath": "src/components/search/search-box-suggestions/atomic-search-box-recent-queries/atomic-search-box-recent-queries.tsx",
       "encapsulation": "shadow",
-      "tag": "atomic-search-box-query-suggestions",
-      "docs": "The `atomic-search-box-query-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of query suggestion behavior.",
+      "tag": "atomic-search-box-recent-queries",
+      "docs": "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.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -12654,10 +12740,10 @@
         },
         {
           "name": "maxWithQuery",
-          "type": "number | undefined",
+          "type": "number",
           "complexType": {
             "original": "number",
-            "resolved": "number | undefined",
+            "resolved": "number",
             "references": {}
           },
           "mutable": false,
@@ -12665,15 +12751,13 @@
           "reflectToAttr": true,
           "docs": "The maximum number of suggestions that will be displayed if the user has typed something into the input field.",
           "docsTags": [],
+          "default": "3",
           "values": [
             {
               "type": "number"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -12713,20 +12797,20 @@
       "dependencies": [],
       "dependencyGraph": {
         "atomic-search-box": [
-          "atomic-search-box-query-suggestions"
+          "atomic-search-box-recent-queries"
         ]
       }
     },
     {
-      "filePath": "src/components/search/search-box-suggestions/atomic-search-box-recent-queries/atomic-search-box-recent-queries.tsx",
+      "filePath": "src/components/search/atomic-search-interface/atomic-search-interface.tsx",
       "encapsulation": "shadow",
-      "tag": "atomic-search-box-recent-queries",
-      "docs": "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.",
+      "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": "icon",
+          "name": "CspNonce",
           "type": "string | undefined",
           "complexType": {
             "original": "string",
@@ -12734,10 +12818,15 @@
             "references": {}
           },
           "mutable": false,
-          "attr": "icon",
-          "reflectToAttr": false,
-          "docs": "The SVG icon to display.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.",
-          "docsTags": [],
+          "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"
@@ -12750,128 +12839,80 @@
           "required": false
         },
         {
-          "name": "maxWithQuery",
-          "type": "number",
+          "name": "analytics",
+          "type": "boolean",
           "complexType": {
-            "original": "number",
-            "resolved": "number",
+            "original": "boolean",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
-          "attr": "max-with-query",
+          "attr": "analytics",
           "reflectToAttr": true,
-          "docs": "The maximum number of suggestions that will be displayed if the user has typed something into the input field.",
+          "docs": "Whether analytics should be enabled.",
           "docsTags": [],
-          "default": "3",
+          "default": "true",
           "values": [
             {
-              "type": "number"
+              "type": "boolean"
             }
           ],
           "optional": false,
           "required": false
         },
         {
-          "name": "maxWithoutQuery",
-          "type": "number | undefined",
+          "name": "enableRelevanceInspector",
+          "type": "boolean",
           "complexType": {
-            "original": "number",
-            "resolved": "number | undefined",
+            "original": "boolean",
+            "resolved": "boolean",
             "references": {}
           },
           "mutable": false,
-          "attr": "max-without-query",
+          "attr": "enable-relevance-inspector",
           "reflectToAttr": true,
-          "docs": "The maximum number of suggestions that will be displayed initially when the input field is empty.",
+          "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": "number"
-            },
-            {
-              "type": "undefined"
+              "type": "boolean"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
-        }
-      ],
-      "methods": [],
-      "events": [],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "atomic-search-box"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "atomic-search-box": [
-          "atomic-search-box-recent-queries"
-        ]
-      }
-    },
-    {
-      "filePath": "src/components/search/facets/atomic-segmented-facet/atomic-segmented-facet.tsx",
-      "encapsulation": "shadow",
-      "tag": "atomic-segmented-facet",
-      "docs": "The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.",
-      "docsTags": [
-        {
-          "name": "part",
-          "text": "segmented-container - The container that holds the segmented facets."
-        },
-        {
-          "name": "part",
-          "text": "label - The facet value label."
-        },
-        {
-          "name": "part",
-          "text": "values - The facet values container."
-        },
-        {
-          "name": "part",
-          "text": "value-box - The facet value."
-        },
-        {
-          "name": "part",
-          "text": "value-box-selected - The selected facet value."
         },
         {
-          "name": "part",
-          "text": "placeholder - The placeholder displayed when the facet is loading."
-        }
-      ],
-      "usage": {},
-      "props": [
-        {
-          "name": "allowedValues",
-          "type": "string | string[]",
+          "name": "engine",
+          "type": "SearchEngine<{}> | undefined",
           "complexType": {
-            "original": "string[] | string",
-            "resolved": "string | string[]",
-            "references": {}
+            "original": "SearchEngine",
+            "resolved": "SearchEngine<{}> | undefined",
+            "references": {
+              "SearchEngine": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::SearchEngine"
+              }
+            }
           },
           "mutable": true,
-          "attr": "allowed-values",
           "reflectToAttr": false,
-          "docs": "Specifies an explicit list of `allowedValues` in the Search API request. This list is in the form of a JSON string.\n\nIf you specify a list of values for this option, the facet only uses these values (if they are available in\nthe current result set).\n\nExample:\n\nThe following facet only uses the `Contact`, `Account`, and `File` values of the `objecttype` field. Even if the\ncurrent result set contains other `objecttype` values, such as `Message` or `Product`, the facet does not use\nthem.\n\n```html\n<atomic-segmented-facet field=\"objecttype\" allowed-values='[\"Contact\",\"Account\",\"File\"]'></atomic-segmented-facet>\n```\n\nThe maximum amount of allowed values is 25.\n\nThe default value is `undefined`, and the facet uses all available values for its `field` in the current result set.",
+          "docs": "The search interface headless engine.",
           "docsTags": [],
-          "default": "'[]'",
           "values": [
             {
-              "type": "string"
+              "type": "SearchEngine<{}>"
             },
             {
-              "type": "string[]"
+              "type": "undefined"
             }
           ],
-          "optional": false,
+          "optional": true,
           "required": false
         },
         {
-          "name": "customSort",
+          "name": "fieldsToInclude",
           "type": "string | string[]",
           "complexType": {
             "original": "string[] | string",
@@ -12879,9 +12920,9 @@
             "references": {}
           },
           "mutable": true,
-          "attr": "custom-sort",
+          "attr": "fields-to-include",
           "reflectToAttr": false,
-          "docs": "Identifies the facet values that must appear at the top, in this order.\nThis parameter can be used in conjunction with the `sortCriteria` parameter.\n\nFacet values not part of the `customSort` list will be sorted according to the `sortCriteria`.\n\nExample:\n\nThe following facet will sort the `Contact`, `Account`, and `File` values at the top of the list for the `objecttype` field.\n\nIf there are more than these 3 values available, the rest of the list will be sorted using `occurrences`.\n\n```html\n<atomic-segmented-facet field=\"objecttype\" custom-sort='[\"Contact\",\"Account\",\"File\"]' sort-criteria='occurrences'></atomic-segmented-facet>\n```\nThe maximum amount of custom sort values is 25.\n\nThe default value is `undefined`, and the facet values will be sorted using only the `sortCriteria`.",
+          "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": [
@@ -12896,57 +12937,55 @@
           "required": false
         },
         {
-          "name": "dependsOn",
-          "type": "{ [x: string]: string; }",
+          "name": "i18n",
+          "type": "i18n",
           "complexType": {
-            "original": "Record<string, string>",
-            "resolved": "{ [x: string]: string; }",
+            "original": "i18n",
+            "resolved": "i18n",
             "references": {
-              "Record": {
-                "location": "global",
-                "id": "global::Record"
+              "i18n": {
+                "location": "import",
+                "path": "i18next",
+                "id": "../../node_modules/i18next/index.d.mts::i18n"
               }
             }
           },
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "The required facets and values for this facet to be displayed.\nExamples:\n```html\n<atomic-segmented-facet facet-id=\"abc\" field=\"objecttype\" ...></atomic-segmented-facet>\n\n<!-- To show the facet when any value is selected in the facet with id \"abc\": -->\n<atomic-segmented-facet\n  depends-on-abc\n  ...\n></atomic-segmented-facet>\n\n<!-- To show the facet when value \"doc\" is selected in the facet with id \"abc\": -->\n<atomic-facet\n  depends-on-abc=\"doc\"\n  ...\n></atomic-segmented-facet>\n```",
+          "docs": "The search interface i18next instance.",
           "docsTags": [],
-          "default": "{}",
           "values": [
             {
-              "type": "{ [x: string]: string; }"
+              "type": "i18n"
             }
           ],
           "optional": false,
           "required": false
         },
         {
-          "name": "facetId",
-          "type": "string | undefined",
+          "name": "iconAssetsPath",
+          "type": "string",
           "complexType": {
             "original": "string",
-            "resolved": "string | undefined",
+            "resolved": "string",
             "references": {}
           },
-          "mutable": true,
-          "attr": "facet-id",
+          "mutable": false,
+          "attr": "icon-assets-path",
           "reflectToAttr": true,
-          "docs": "Specifies a unique identifier for the facet.",
+          "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"
-            },
-            {
-              "type": "undefined"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
-          "name": "field",
+          "name": "language",
           "type": "string",
           "complexType": {
             "original": "string",
@@ -12954,20 +12993,507 @@
             "references": {}
           },
           "mutable": false,
-          "attr": "field",
+          "attr": "language",
           "reflectToAttr": true,
-          "docs": "The field whose values you want to display in the facet.",
+          "docs": "The search interface language.",
           "docsTags": [],
+          "default": "'en'",
           "values": [
             {
               "type": "string"
             }
           ],
           "optional": false,
-          "required": true
+          "required": false
         },
         {
-          "name": "filterFacetCount",
+          "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",
+      "tag": "atomic-segmented-facet",
+      "docs": "The `atomic-segmented-facet` displays a horizontal facet of the results for the current query.",
+      "docsTags": [
+        {
+          "name": "part",
+          "text": "segmented-container - The container that holds the segmented facets."
+        },
+        {
+          "name": "part",
+          "text": "label - The facet value label."
+        },
+        {
+          "name": "part",
+          "text": "values - The facet values container."
+        },
+        {
+          "name": "part",
+          "text": "value-box - The facet value."
+        },
+        {
+          "name": "part",
+          "text": "value-box-selected - The selected facet value."
+        },
+        {
+          "name": "part",
+          "text": "placeholder - The placeholder displayed when the facet is loading."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "allowedValues",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "allowed-values",
+          "reflectToAttr": false,
+          "docs": "Specifies an explicit list of `allowedValues` in the Search API request. This list is in the form of a JSON string.\n\nIf you specify a list of values for this option, the facet only uses these values (if they are available in\nthe current result set).\n\nExample:\n\nThe following facet only uses the `Contact`, `Account`, and `File` values of the `objecttype` field. Even if the\ncurrent result set contains other `objecttype` values, such as `Message` or `Product`, the facet does not use\nthem.\n\n```html\n<atomic-segmented-facet field=\"objecttype\" allowed-values='[\"Contact\",\"Account\",\"File\"]'></atomic-segmented-facet>\n```\n\nThe maximum amount of allowed values is 25.\n\nThe default value is `undefined`, and the facet uses all available values for its `field` in the current result set.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "customSort",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "custom-sort",
+          "reflectToAttr": false,
+          "docs": "Identifies the facet values that must appear at the top, in this order.\nThis parameter can be used in conjunction with the `sortCriteria` parameter.\n\nFacet values not part of the `customSort` list will be sorted according to the `sortCriteria`.\n\nExample:\n\nThe following facet will sort the `Contact`, `Account`, and `File` values at the top of the list for the `objecttype` field.\n\nIf there are more than these 3 values available, the rest of the list will be sorted using `occurrences`.\n\n```html\n<atomic-segmented-facet field=\"objecttype\" custom-sort='[\"Contact\",\"Account\",\"File\"]' sort-criteria='occurrences'></atomic-segmented-facet>\n```\nThe maximum amount of custom sort values is 25.\n\nThe default value is `undefined`, and the facet values will be sorted using only the `sortCriteria`.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "dependsOn",
+          "type": "{ [x: string]: string; }",
+          "complexType": {
+            "original": "Record<string, string>",
+            "resolved": "{ [x: string]: string; }",
+            "references": {
+              "Record": {
+                "location": "global",
+                "id": "global::Record"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The required facets and values for this facet to be displayed.\nExamples:\n```html\n<atomic-segmented-facet facet-id=\"abc\" field=\"objecttype\" ...></atomic-segmented-facet>\n\n<!-- To show the facet when any value is selected in the facet with id \"abc\": -->\n<atomic-segmented-facet\n  depends-on-abc\n  ...\n></atomic-segmented-facet>\n\n<!-- To show the facet when value \"doc\" is selected in the facet with id \"abc\": -->\n<atomic-facet\n  depends-on-abc=\"doc\"\n  ...\n></atomic-segmented-facet>\n```",
+          "docsTags": [],
+          "default": "{}",
+          "values": [
+            {
+              "type": "{ [x: string]: string; }"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "facetId",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "facet-id",
+          "reflectToAttr": true,
+          "docs": "Specifies a unique identifier for the facet.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "field",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "field",
+          "reflectToAttr": true,
+          "docs": "The field whose values you want to display in the facet.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "filterFacetCount",
           "type": "boolean",
           "complexType": {
             "original": "boolean",
@@ -15369,16 +15895,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": "",
@@ -15609,6 +16155,11 @@
       "docstring": "",
       "path": "src/utils/initialization-utils.tsx"
     },
+    "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.tsx"
+    },
     "../headless/dist/definitions/index.d.ts::FoldedResult": {
       "declaration": "any",
       "docstring": "",