feature: add openLinksInNewTab as a new parameter for the search component and public page

Author: cdxker

clients/search-component/package.json

@@ -19,7 +19,7 @@
       "import": "./dist/vanilla/index.js"
     }
   },
-  "version": "0.2.9",
+  "version": "0.2.10",
   "license": "MIT",
   "homepage": "https://github.com/devflowinc/trieve/tree/main/clients/search-component",
   "scripts": {

clients/search-component/src/TrieveModal/Search/DocsItem.tsx

@@ -60,12 +60,11 @@ export const DocsItem = ({ item, requestID, index, className }: Props) => {
     descriptionHtml = descriptionHtml.replace(curHeadingText || "", "");
   }
   descriptionHtml = descriptionHtml.replace(/([.,!?;:])/g, "$1 ");
-  let title = `${
-    cleanFirstHeading ||
+  let title = `${cleanFirstHeading ||
     item.chunk.metadata?.title ||
     item.chunk.metadata?.page_title ||
     item.chunk.metadata?.name
-  }`.replace("#", "");
+    }`.replace("#", "");
 
   if (!title.trim() || title == "undefined") {
     return null;
@@ -102,8 +101,8 @@ export const DocsItem = ({ item, requestID, index, className }: Props) => {
         .map((word) => word.replace(/-/g, " "))
         .concat(
           item.chunk.metadata?.title ||
-            item.chunk.metadata.summary ||
-            urlElements.slice(-1)[0]
+          item.chunk.metadata.summary ||
+          urlElements.slice(-1)[0]
         )
         .map((word) =>
           word
@@ -143,6 +142,7 @@ export const DocsItem = ({ item, requestID, index, className }: Props) => {
     <li key={item.chunk.id}>
       <Component
         ref={itemRef}
+        target={props.openLinksInNewTab ? "_blank" : ""}
         id={`trieve-search-item-${index + 1}`}
         className={className ?? "item"}
         onClick={() =>
@@ -162,12 +162,11 @@ export const DocsItem = ({ item, requestID, index, className }: Props) => {
         }}
         {...(item.chunk.link
           ? {
-              href: `${
-                item.chunk.link.endsWith("/")
-                  ? item.chunk.link.slice(0, -1)
-                  : item.chunk.link
+            href: `${item.chunk.link.endsWith("/")
+                ? item.chunk.link.slice(0, -1)
+                : item.chunk.link
               }${linkSuffix}`,
-            }
+          }
           : {})}
       >
         <div>

clients/search-component/src/utils/hooks/modal-context.tsx

@@ -66,6 +66,7 @@ export type ModalProps = {
   currencyPosition?: currencyPosition;
   responsive?: boolean;
   open?: boolean;
+  openLinksInNewTab?: boolean;
   onOpenChange?: (open: boolean) => void;
   debounceMs?: number;
 };
@@ -93,6 +94,7 @@ const defaultProps = {
   useGroupSearch: false,
   allowSwitchingModes: true,
   defaultCurrency: "$",
+  openLinksInNewTab: false,
   currencyPosition: "before" as currencyPosition,
   responsive: false,
   debounceMs: 0,

clients/ts-sdk/openapi.json

@@ -12068,6 +12068,10 @@
             ],
             "nullable": true
           },
+          "openLinksInNewTab": {
+            "type": "boolean",
+            "nullable": true
+          },
           "placeholder": {
             "type": "string",
             "nullable": true

clients/ts-sdk/src/types.gen.ts

@@ -1978,6 +1978,7 @@ export type PublicPageParameters = {
     heroPattern?: ((HeroPattern) | null);
     navLogoImgSrcUrl?: (string) | null;
     openGraphMetadata?: ((OpenGraphMetadata) | null);
+    openLinksInNewTab?: (boolean) | null;
     placeholder?: (string) | null;
     problemLink?: (string) | null;
     responsive?: (boolean) | null;

frontends/dashboard/src/pages/dataset/PublicPageSettings.tsx

@@ -647,6 +647,33 @@ const PublicPageControls = () => {
                 />
               </div>
             </div>
+            <div class="grid grid-cols-2 gap-4">
+              <div class="flex gap-2">
+                <div class="flex items-center gap-1">
+                  <label class="block" for="">
+                    Default Open in new tab
+                  </label>
+                  <Tooltip
+                    tooltipText="Enable users to switch between search modes"
+                    body={
+                      <FaRegularCircleQuestion class="h-3 w-3 text-black" />
+                    }
+                  />
+                </div>
+                <input
+                  type="checkbox"
+                  checked={extraParams.openLinksInNewTab || false}
+                  onChange={(e) => {
+                    setExtraParams(
+                      "openLinksInNewTab",
+                      e.currentTarget.checked,
+                    );
+                  }}
+                  class="block w-4 rounded border border-neutral-300 px-3 py-1.5 shadow-sm placeholder:text-neutral-400 focus:outline-magenta-500 sm:text-sm sm:leading-6"
+                />
+              </div>
+            </div>
+
           </div>
         </details>
 

server/Dockerfile.server

@@ -6,7 +6,9 @@ RUN cargo install cargo-chef
 WORKDIR /app
 
 FROM chef AS planner
+RUN mkdir /hallucination-detection
 COPY . .
+COPY ../hallucination-detection/ /hallucination-detection
 RUN cargo chef prepare  --recipe-path recipe.json
 
 FROM chef AS builder

server/src/data/models.rs

@@ -3164,6 +3164,9 @@ impl DatasetConfigurationDTO {
                     open_graph_metadata: page_parameters_self
                         .open_graph_metadata
                         .or(page_parameters_curr.open_graph_metadata),
+                    open_links_in_new_tab: page_parameters_self
+                        .open_links_in_new_tab
+                        .or(page_parameters_curr.open_links_in_new_tab),
                 }),
             },
             DISABLE_ANALYTICS: self

server/src/handlers/page_handler.rs

@@ -192,6 +192,8 @@ pub struct PublicPageParameters {
     pub tab_messages: Option<Vec<PublicPageTabMessage>>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub open_graph_metadata: Option<OpenGraphMetadata>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub open_links_in_new_tab: Option<bool>,
 }
 
 #[utoipa::path(

server/src/public/page.html

@@ -4,7 +4,7 @@
     <link rel="stylesheet" href="/static/output.css" />
     <link
       rel="stylesheet"
-      href="https://unpkg.com/[email protected].9/dist/index.css"
+      href="https://unpkg.com/[email protected].10/dist/index.css"
     />
     <link
       rel="apple-touch-icon"
@@ -181,7 +181,7 @@
     </style>
 
     <script type="module">
-      import {renderToDiv} from 'https://unpkg.com/[email protected].9/dist/vanilla/index.js';
+      import {renderToDiv} from 'https://unpkg.com/[email protected].10/dist/vanilla/index.js';
       window.addEventListener('load', () => {
         const root = document.getElementById('root');
         renderToDiv(root, {