@coveo/atomic 3.32.4-pre.508d41b59e → 3.32.4-pre.51ef30e2ab

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-08-13T20:39:32",
+  "timestamp": "2025-08-17T20:48:59",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -3999,6 +3999,622 @@
         ]
       }
     },
+    {
+      "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",
+      "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/insight/user-actions/atomic-insight-user-actions-toggle/atomic-insight-user-actions-toggle.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-insight-user-actions-toggle",
+      "docs": "Internal component of the atomic-insight-interface\nThe `atomic-insight-user-actions-toggle` component displays a button that opens a modal containing the user actions timeline component.",
+      "docsTags": [],
+      "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.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "atomic-insight-user-actions-modal"
+      ],
+      "dependencyGraph": {
+        "atomic-insight-user-actions-toggle": [
+          "atomic-insight-user-actions-modal"
+        ],
+        "atomic-insight-user-actions-modal": [
+          "atomic-insight-user-actions-timeline",
+          "atomic-modal"
+        ],
+        "atomic-insight-user-actions-timeline": [
+          "atomic-insight-user-actions-session"
+        ],
+        "atomic-modal": [
+          "atomic-focus-trap"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/atomic-load-more-results/atomic-load-more-results.tsx",
       "encapsulation": "shadow",
@@ -12604,7 +13220,7 @@
               "docs": ""
             }
           ],
-          "docs": "Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/search/), 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.",
+          "docs": "Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/modules/Search.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": []
         }
       ],