@coveo/atomic 3.34.0-pre.e940bd417f → 3.34.0-pre.ebcb0fe404

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-10-03T20:14:34",
+  "timestamp": "2025-10-06T18:18:20",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -4276,406 +4276,6 @@
         ]
       }
     },
-    {
-      "filePath": "src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx",
-      "encapsulation": "shadow",
-      "tag": "atomic-insight-interface",
-      "docs": "",
-      "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: [...].\nWhen using a nonce, the first import of Atomic should be to import & call the `setNonce` function with the generated nonce value.",
-          "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": "engine",
-          "type": "InsightEngine<{}> | undefined",
-          "complexType": {
-            "original": "InsightEngine",
-            "resolved": "InsightEngine<{}> | undefined",
-            "references": {
-              "InsightEngine": {
-                "location": "import",
-                "path": "@coveo/headless/insight",
-                "id": "../headless/dist/definitions/insight.index.d.ts::InsightEngine"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The service insight interface headless engine.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "InsightEngine<{}>"
-            },
-            {
-              "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-insight-interface fields-to-include='[\"fieldA\", \"fieldB\"]'></atomic-insight-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 service insight 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 service insight 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": "InsightLogLevel",
-            "resolved": "\"debug\" | \"error\" | \"fatal\" | \"info\" | \"silent\" | \"trace\" | \"warn\" | undefined",
-            "references": {
-              "InsightLogLevel": {
-                "location": "import",
-                "path": "@coveo/headless/insight",
-                "id": "../headless/dist/definitions/insight.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": "resultsPerPage",
-          "type": "number",
-          "complexType": {
-            "original": "number",
-            "resolved": "number",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "results-per-page",
-          "reflectToAttr": true,
-          "docs": "The number of results per page. By default, this is set to `5`.",
-          "docsTags": [],
-          "default": "5",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [
-        {
-          "name": "executeFirstSearch",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "() => Promise<void>",
-            "parameters": [],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              }
-            },
-            "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: InsightInitializationOptions) => Promise<void>",
-            "parameters": [
-              {
-                "name": "options",
-                "type": "InsightEngineConfiguration",
-                "docs": ""
-              }
-            ],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              },
-              "InsightInitializationOptions": {
-                "location": "local",
-                "path": "/home/runner/work/ui-kit/ui-kit/packages/atomic/src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx",
-                "id": "src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx::InsightInitializationOptions"
-              }
-            },
-            "return": "Promise<void>"
-          },
-          "signature": "initialize(options: InsightInitializationOptions) => Promise<void>",
-          "parameters": [
-            {
-              "name": "options",
-              "type": "InsightEngineConfiguration",
-              "docs": ""
-            }
-          ],
-          "docs": "Initializes the connection with the headless insight engine using options for `accessToken` (required), `organizationId` (required), `environment` (defaults to `prod`), and `renewAccessToken`.",
-          "docsTags": []
-        },
-        {
-          "name": "initializeWithInsightEngine",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(engine: InsightEngine) => Promise<void>",
-            "parameters": [
-              {
-                "name": "engine",
-                "type": "InsightEngine<{}>",
-                "docs": ""
-              }
-            ],
-            "references": {
-              "Promise": {
-                "location": "global",
-                "id": "global::Promise"
-              },
-              "InsightEngine": {
-                "location": "import",
-                "path": "@coveo/headless/insight",
-                "id": "../headless/dist/definitions/insight.index.d.ts::InsightEngine"
-              }
-            },
-            "return": "Promise<void>"
-          },
-          "signature": "initializeWithInsightEngine(engine: InsightEngine) => Promise<void>",
-          "parameters": [
-            {
-              "name": "engine",
-              "type": "InsightEngine<{}>",
-              "docs": ""
-            }
-          ],
-          "docs": "Initializes the connection with an already preconfigured headless insight engine.",
-          "docsTags": []
-        }
-      ],
-      "events": [],
-      "listeners": [
-        {
-          "event": "atomic/initializeComponent",
-          "capture": false,
-          "passive": false
-        }
-      ],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
-    },
     {
       "filePath": "src/components/insight/user-actions/atomic-insight-user-actions-timeline/atomic-insight-user-actions-timeline.tsx",
       "encapsulation": "shadow",
@@ -9175,88 +8775,6 @@
         ]
       }
     },
-    {
-      "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, AtomicSearchInterface> & NonceBindings",
-          "complexType": {
-            "original": "Bindings",
-            "resolved": "CommonBindings<SearchEngine<{}>, SearchStore, AtomicSearchInterface> & NonceBindings",
-            "references": {
-              "Bindings": {
-                "location": "import",
-                "path": "../atomic-search-interface/atomic-search-interface",
-                "id": "src/components/search/atomic-search-interface/atomic-search-interface.ts::Bindings"
-              }
-            }
-          },
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The Atomic interface bindings, namely the headless search engine and i18n instances.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "CommonBindings<SearchEngine<{}>, SearchStore, AtomicSearchInterface> & 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": [],
-      "dependencies": [],
-      "dependencyGraph": {}
-    },
     {
       "filePath": "src/components/search/atomic-result/atomic-result.tsx",
       "encapsulation": "shadow",
@@ -12308,12 +11826,14 @@
       "dependents": [],
       "dependencies": [
         "atomic-suggestion-renderer",
-        "atomic-search-box-recent-queries"
+        "atomic-search-box-recent-queries",
+        "atomic-search-box-query-suggestions"
       ],
       "dependencyGraph": {
         "atomic-search-box": [
           "atomic-suggestion-renderer",
-          "atomic-search-box-recent-queries"
+          "atomic-search-box-recent-queries",
+          "atomic-search-box-query-suggestions"
         ]
       }
     },
@@ -12534,6 +12054,103 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/search/search-box-suggestions/atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.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.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "icon",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "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": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "maxWithQuery",
+          "type": "number | undefined",
+          "complexType": {
+            "original": "number",
+            "resolved": "number | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "max-with-query",
+          "reflectToAttr": true,
+          "docs": "The maximum number of suggestions that will be displayed if the user has typed something into the input field.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "maxWithoutQuery",
+          "type": "number | undefined",
+          "complexType": {
+            "original": "number",
+            "resolved": "number | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "max-without-query",
+          "reflectToAttr": true,
+          "docs": "The maximum number of suggestions that will be displayed initially when the input field is empty.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-search-box"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-search-box": [
+          "atomic-search-box-query-suggestions"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/search-box-suggestions/atomic-search-box-recent-queries/atomic-search-box-recent-queries.tsx",
       "encapsulation": "shadow",
@@ -15186,26 +14803,6 @@
     }
   ],
   "typeLibrary": {
-    "../headless/dist/definitions/insight.index.d.ts::InsightEngine": {
-      "declaration": "any",
-      "docstring": "",
-      "path": "../headless/dist/definitions/insight.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/insight.index.d.ts::LogLevel": {
-      "declaration": "any",
-      "docstring": "",
-      "path": "../headless/dist/definitions/insight.index.d.ts"
-    },
-    "src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx::InsightInitializationOptions": {
-      "declaration": "export interface InsightEngineConfiguration extends EngineConfiguration {\n    /**\n     * Specifies the unique identifier of the target insight configuration.\n     */\n    insightId: string;\n    /**\n     * Specifies the configuration for the insight search.\n     */\n    search?: InsightEngineSearchConfigurationOptions;\n}",
-      "docstring": "The insight engine configuration.",
-      "path": "src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx"
-    },
     "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}",
       "docstring": "",
@@ -15226,6 +14823,11 @@
       "docstring": "",
       "path": "../headless/dist/definitions/recommendation.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/recommendation.index.d.ts::LogLevel": {
       "declaration": "any",
       "docstring": "",
@@ -15426,11 +15028,6 @@
       "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;",
-      "docstring": "",
-      "path": "src/components/search/atomic-search-interface/atomic-search-interface.ts"
-    },
     "../headless/dist/definitions/index.d.ts::FoldedResult": {
       "declaration": "any",
       "docstring": "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coveo/atomic",
   "type": "module",
-  "version": "3.34.0-pre.e940bd417f",
+  "version": "3.34.0-pre.ebcb0fe404",
   "description": "A web-component library for building modern UIs interfacing with the Coveo platform",
   "homepage": "https://docs.coveo.com/en/atomic/latest/",
   "repository": {