@inkeep/cxkit-types 0.5.29 → 0.5.31

package/dist/index.d.ts

@@ -164,7 +164,7 @@ export declare interface AssistantSourceItemClickedEvent {
     };
 }
 
-export declare type AvailableBuiltInIcons = 'FaBook' | 'FaGithub' | 'FaDatabase' | 'FaStackOverflow' | 'FaChrome' | 'FaPhone' | 'FaEnvelope' | 'FaPencil' | 'FaBlog' | 'FaSort' | 'FaPenSquare' | 'FaChevronRight' | 'FaChevronUp' | 'FaFilePdf' | 'FaDiscourse' | 'FaDiscord' | 'FaSlack' | 'IoDocumentTextSharp' | 'IoDocumentSharp' | 'IoSend' | 'IoInformationCircleOutline' | 'IoLinkOutline' | 'IoThumbsUpSharp' | 'IoThumbsDownSharp' | 'IoSearch' | 'IoCopyOutline' | 'IoCopy' | 'IoReturnDownBackOutline' | 'IoChevronForwardOutline' | 'IoReturnDownForward' | 'IoCloseOutline' | 'IoCheckmarkOutline' | 'IoBookOutline' | 'IoReaderOutline' | 'IoHelpBuoyOutline' | 'IoPeopleOutline' | 'IoDocumentTextOutline' | 'IoChatbubblesOutline' | 'FaRegFilePdf' | 'IoLogoDiscord' | 'IoLogoGithub' | 'IoTerminal' | 'FaBriefcase' | 'IoPlayCircleOutline' | 'IoPencilOutline' | 'IoCheckmarkDoneOutline' | 'IoHomeOutline' | 'IoMail' | 'IoOpenOutline' | 'FaTelegram' | 'FaTable' | 'FaMagnifyingGlass' | 'LuArrowLeft' | 'LuCircleCheck' | 'LuCommand' | 'LuCopy' | 'LuCheck' | 'LuCornerDownLeft' | 'LuRepeat' | 'LuThumbsDown' | 'LuThumbsUp' | 'LuUsers' | 'LuUser' | 'LuArrowUpRight' | 'LuBookOpen' | 'LuChevronDown' | 'LuLoaderCircle' | 'FiEdit' | 'LuSparkles';
+export declare type AvailableBuiltInIcons = 'FaBook' | 'FaGithub' | 'FaDatabase' | 'FaStackOverflow' | 'FaChrome' | 'FaPhone' | 'FaEnvelope' | 'FaPencil' | 'FaBlog' | 'FaSort' | 'FaPenSquare' | 'FaChevronRight' | 'FaChevronUp' | 'FaFilePdf' | 'FaDiscourse' | 'FaDiscord' | 'FaSlack' | 'IoDocumentTextSharp' | 'IoDocumentSharp' | 'IoSend' | 'IoInformationCircleOutline' | 'IoLinkOutline' | 'IoThumbsUpSharp' | 'IoThumbsDownSharp' | 'IoSearch' | 'IoCopyOutline' | 'IoCopy' | 'IoReturnDownBackOutline' | 'IoChevronForwardOutline' | 'IoReturnDownForward' | 'IoCloseOutline' | 'IoCheckmarkOutline' | 'IoBookOutline' | 'IoReaderOutline' | 'IoHelpBuoyOutline' | 'IoPeopleOutline' | 'IoDocumentTextOutline' | 'IoChatbubblesOutline' | 'FaRegFilePdf' | 'IoLogoDiscord' | 'IoLogoGithub' | 'IoTerminal' | 'FaBriefcase' | 'IoPlayCircleOutline' | 'IoPencilOutline' | 'IoCheckmarkDoneOutline' | 'IoHomeOutline' | 'IoMail' | 'IoOpenOutline' | 'FaTelegram' | 'FaTable' | 'FaMagnifyingGlass' | 'LuArrowLeft' | 'LuCircleCheck' | 'LuCommand' | 'LuCopy' | 'LuCheck' | 'LuCornerDownLeft' | 'LuGlobe' | 'LuLink' | 'LuRepeat' | 'LuThumbsDown' | 'LuThumbsUp' | 'LuUsers' | 'LuUser' | 'LuArrowUpRight' | 'LuBookOpen' | 'LuChevronDown' | 'LuLoaderCircle' | 'FiEdit' | 'LuSparkles' | 'LuCornerDownRight';
 
 export declare interface BaseFormField {
     name: string;
@@ -328,6 +328,7 @@ export declare interface CustomIcons {
     codeCopied: string;
     openLinkInNewTab: string;
     openLinkInSameTab: string;
+    newLine: string;
     breadcrumbSeparator: string;
     switchToSearch: string;
     switchToChat: string;
@@ -812,6 +813,11 @@ export declare interface InkeepSearchSettings {
      *
      */
     searchQueryParamKey?: string;
+    /**
+     * The view to use for the search.
+     * @default 'single-pane'
+     */
+    view?: 'single-pane' | 'dual-pane';
     /**
      * Filters to apply to the search results.
      */
@@ -1029,10 +1035,12 @@ export declare interface SearchHit {
     url?: string;
     preview?: string;
     pathHeadings?: {
+        anchor?: string | null;
         content: string;
     }[];
     content?: {
         content: string;
+        anchor?: string | null;
     };
 }
 
@@ -1073,6 +1081,7 @@ export declare interface SearchRootRecord {
     preview?: string;
     pathBreadcrumbs?: string[];
     contentType?: string;
+    topLevelHeadings?: TopLevelHeading[];
     body?: string;
     state?: `${GitHubIssueState}`;
     markedAsCorrectAnswer?: {
@@ -1356,6 +1365,13 @@ export declare type ToolsJSONSchema = {
     [key: string]: unknown;
 };
 
+export declare interface TopLevelHeading {
+    anchor?: string | null;
+    url?: string | null;
+    content: string;
+    isMatch?: boolean;
+}
+
 export declare interface TransformedSource {
     /**
      * ID of the source.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/cxkit-types",
-  "version": "0.5.29",
+  "version": "0.5.31",
   "description": "",
   "license": "Inkeep, Inc. Customer License (IICL) v1.1",
   "homepage": "",