@paymanai/payman-ask-sdk 1.2.19 → 1.2.21

package/dist/index.d.mts

@@ -49,6 +49,8 @@ type MessageDisplay = {
     activeThinkingText?: string;
     /** All thinking accumulated across blocks (for post-stream display) */
     allThinkingText?: string;
+    /** True while RAG image URLs are being resolved after the final response is shown */
+    isResolvingImages?: boolean;
 };
 type SessionParams = {
     id?: string;
@@ -64,6 +66,8 @@ type APIConfig = {
     headers?: Record<string, string>;
     /** API endpoint for streaming (default: /api/workflows/ask/stream) */
     streamEndpoint?: string;
+    /** API endpoint for resolving RAG image URLs (default: /api/playground/ask/resolve-image-urls) */
+    resolveImagesEndpoint?: string;
 };
 type ChatConfig = {
     /** API configuration - required for the library to make calls */
@@ -134,6 +138,12 @@ type ChatConfig = {
     voiceContinuous?: boolean;
     /** Show a "New Session" reset button inside the input bar (default: false) */
     showResetSession?: boolean;
+    /**
+     * Sentry DSN for error monitoring.
+     * The library will initialise Sentry with this DSN if Sentry has not already
+     * been initialised by the host application.
+     */
+    sentryDsn?: string;
 };
 type ChatCallbacks = {
     /** Called when a message is sent (before API call) */

package/dist/index.d.ts

@@ -49,6 +49,8 @@ type MessageDisplay = {
     activeThinkingText?: string;
     /** All thinking accumulated across blocks (for post-stream display) */
     allThinkingText?: string;
+    /** True while RAG image URLs are being resolved after the final response is shown */
+    isResolvingImages?: boolean;
 };
 type SessionParams = {
     id?: string;
@@ -64,6 +66,8 @@ type APIConfig = {
     headers?: Record<string, string>;
     /** API endpoint for streaming (default: /api/workflows/ask/stream) */
     streamEndpoint?: string;
+    /** API endpoint for resolving RAG image URLs (default: /api/playground/ask/resolve-image-urls) */
+    resolveImagesEndpoint?: string;
 };
 type ChatConfig = {
     /** API configuration - required for the library to make calls */
@@ -134,6 +138,12 @@ type ChatConfig = {
     voiceContinuous?: boolean;
     /** Show a "New Session" reset button inside the input bar (default: false) */
     showResetSession?: boolean;
+    /**
+     * Sentry DSN for error monitoring.
+     * The library will initialise Sentry with this DSN if Sentry has not already
+     * been initialised by the host application.
+     */
+    sentryDsn?: string;
 };
 type ChatCallbacks = {
     /** Called when a message is sent (before API call) */

package/dist/index.js

@@ -5,13 +5,34 @@ var framerMotion = require('framer-motion');
 var react = require('react');
 var clsx = require('clsx');
 var tailwindMerge = require('tailwind-merge');
+var Sentry = require('@sentry/react');
 var lucideReact = require('lucide-react');
 var jsxRuntime = require('react/jsx-runtime');
 var ReactMarkdown = require('react-markdown');
 var remarkGfm = require('remark-gfm');
+var reactDom = require('react-dom');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var Sentry__namespace = /*#__PURE__*/_interopNamespace(Sentry);
 var ReactMarkdown__default = /*#__PURE__*/_interopDefault(ReactMarkdown);
 var remarkGfm__default = /*#__PURE__*/_interopDefault(remarkGfm);
 
@@ -58,6 +79,17 @@ function formatElapsedTime(ms) {
   if (ms < 1e3) return `${ms}ms`;
   return `${(ms / 1e3).toFixed(1)}s`;
 }
+function initSentryIfNeeded(dsn) {
+  if (!dsn) return;
+  if (Sentry__namespace.getClient()) return;
+  Sentry__namespace.init({
+    dsn,
+    sendDefaultPii: true,
+    initialScope: {
+      tags: { source: "payman-ask-sdk" }
+    }
+  });
+}
 var AI_DISCLAIMER_TEXT = "AI can make mistakes. Please double-check responses.";
 function ChatInput({
   value,
@@ -321,6 +353,256 @@ function ChatInput({
     }
   );
 }
+function ImageLightbox({
+  src,
+  alt = "",
+  onClose
+}) {
+  const [isMounted, setIsMounted] = react.useState(false);
+  const [isImageLoaded, setIsImageLoaded] = react.useState(false);
+  const overlayStyle = {
+    position: "fixed",
+    inset: 0,
+    zIndex: 2147483647,
+    display: "flex",
+    alignItems: "center",
+    justifyContent: "center",
+    padding: 16,
+    background: "rgba(2, 6, 23, 0.92)",
+    isolation: "isolate"
+  };
+  const frameStyle = {
+    position: "relative",
+    width: "min(92vw, 1280px)",
+    height: "min(88vh, 920px)",
+    display: "flex",
+    alignItems: "center",
+    justifyContent: "center",
+    overflow: "hidden"
+  };
+  react.useEffect(() => {
+    setIsMounted(true);
+    return () => setIsMounted(false);
+  }, []);
+  react.useEffect(() => {
+    setIsImageLoaded(false);
+  }, [src]);
+  react.useEffect(() => {
+    if (typeof document === "undefined") return;
+    const previousOverflow = document.body.style.overflow;
+    document.body.style.overflow = "hidden";
+    return () => {
+      document.body.style.overflow = previousOverflow;
+    };
+  }, []);
+  react.useEffect(() => {
+    if (typeof document === "undefined") return;
+    const handleKeyDown = (event) => {
+      if (event.key === "Escape") {
+        onClose();
+      }
+    };
+    document.addEventListener("keydown", handleKeyDown);
+    return () => {
+      document.removeEventListener("keydown", handleKeyDown);
+    };
+  }, [onClose]);
+  if (!isMounted || typeof document === "undefined") {
+    return null;
+  }
+  return reactDom.createPortal(
+    /* @__PURE__ */ jsxRuntime.jsx(framerMotion.AnimatePresence, { children: /* @__PURE__ */ jsxRuntime.jsxs(
+      framerMotion.motion.div,
+      {
+        style: overlayStyle,
+        initial: { opacity: 0 },
+        animate: { opacity: 1 },
+        exit: { opacity: 0 },
+        transition: { duration: 0.18 },
+        onClick: onClose,
+        children: [
+          /* @__PURE__ */ jsxRuntime.jsx(
+            "button",
+            {
+              type: "button",
+              onClick: onClose,
+              className: "absolute top-4 right-4 z-[1] flex h-9 w-9 items-center justify-center rounded-full bg-black/60 text-white/90 transition-colors hover:bg-black/75",
+              "aria-label": "Close",
+              children: /* @__PURE__ */ jsxRuntime.jsx(lucideReact.X, { className: "h-4 w-4" })
+            }
+          ),
+          /* @__PURE__ */ jsxRuntime.jsxs("div", { style: frameStyle, onClick: (event) => event.stopPropagation(), children: [
+            !isImageLoaded ? /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "absolute inset-0 flex flex-col items-center justify-center gap-2", children: [
+              /* @__PURE__ */ jsxRuntime.jsx(lucideReact.Loader2, { className: "h-5 w-5 animate-spin text-white/80" }),
+              /* @__PURE__ */ jsxRuntime.jsx("p", { className: "text-sm font-medium text-white/90", children: "Loading image" }),
+              /* @__PURE__ */ jsxRuntime.jsx("p", { className: "text-xs text-white/60", children: "Reference image" })
+            ] }) : null,
+            /* @__PURE__ */ jsxRuntime.jsx("div", { className: "flex h-full w-full items-center justify-center p-3 sm:p-4", children: /* @__PURE__ */ jsxRuntime.jsx(
+              "img",
+              {
+                src,
+                alt,
+                draggable: false,
+                onLoad: () => setIsImageLoaded(true),
+                className: `block h-full w-full rounded-xl object-contain shadow-2xl transition-opacity duration-200 ${isImageLoaded ? "opacity-100" : "opacity-0"}`
+              }
+            ) })
+          ] })
+        ]
+      }
+    ) }),
+    document.body
+  );
+}
+var RAG_IMAGE_PATH_REGEX = /^(?:https?:\/\/[^/\s]+)?\/api\/rag\/chunks\/[^"'\s]+\/image(?:[?#][^"'\s]*)?$/;
+function isUnresolvedRagImageSource(src) {
+  return RAG_IMAGE_PATH_REGEX.test(src);
+}
+function LoadingImageCard({
+  label,
+  description
+}) {
+  return /* @__PURE__ */ jsxRuntime.jsxs("span", { className: "my-3 flex min-h-36 w-full flex-col items-center justify-center gap-2 px-4 py-5 text-center", children: [
+    /* @__PURE__ */ jsxRuntime.jsx(lucideReact.Loader2, { className: "h-5 w-5 animate-spin text-slate-500 dark:text-slate-300" }),
+    /* @__PURE__ */ jsxRuntime.jsx("span", { className: "text-xs font-medium text-slate-600 dark:text-slate-200", children: label }),
+    /* @__PURE__ */ jsxRuntime.jsx("span", { className: "text-[11px] leading-relaxed text-slate-500/90 dark:text-slate-300/80", children: description })
+  ] });
+}
+function BrokenImageCard({ alt }) {
+  return /* @__PURE__ */ jsxRuntime.jsxs("span", { className: "my-3 flex min-h-44 w-full flex-col items-center justify-center gap-2 rounded-xl border border-dashed border-red-200 bg-red-50/60 px-4 py-5 text-center dark:border-red-900/40 dark:bg-red-950/20", children: [
+    /* @__PURE__ */ jsxRuntime.jsx("span", { className: "text-xs font-medium text-red-600 dark:text-red-300", children: "Unable to load image" }),
+    alt ? /* @__PURE__ */ jsxRuntime.jsx("span", { className: "max-w-sm text-[11px] leading-relaxed text-red-500/80 dark:text-red-200/80", children: alt }) : null
+  ] });
+}
+function MarkdownImage({
+  src,
+  alt,
+  isResolving = false
+}) {
+  const imageFrameStyle = {
+    width: "min(100%, 32rem)",
+    maxWidth: "100%"
+  };
+  const imageStyle = {
+    display: "block",
+    width: "100%",
+    height: "auto",
+    maxWidth: "100%",
+    maxHeight: "18rem",
+    objectFit: "contain"
+  };
+  const [isLoaded, setIsLoaded] = react.useState(false);
+  const [hasError, setHasError] = react.useState(false);
+  const [isLightboxOpen, setIsLightboxOpen] = react.useState(false);
+  const isUnresolvedRagImage = react.useMemo(
+    () => src ? isUnresolvedRagImageSource(src) : false,
+    [src]
+  );
+  const isResolvingRagImage = isResolving && isUnresolvedRagImage;
+  react.useEffect(() => {
+    setIsLoaded(false);
+    setHasError(false);
+    setIsLightboxOpen(false);
+  }, [src]);
+  if (!src) {
+    return null;
+  }
+  if (isResolvingRagImage) {
+    return /* @__PURE__ */ jsxRuntime.jsx(LoadingImageCard, { label: "Loading image", description: "Reference image" });
+  }
+  if (hasError) {
+    return /* @__PURE__ */ jsxRuntime.jsx(BrokenImageCard, { alt });
+  }
+  return /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
+    /* @__PURE__ */ jsxRuntime.jsx("span", { className: "my-3 block w-full", children: /* @__PURE__ */ jsxRuntime.jsx(
+      "button",
+      {
+        type: "button",
+        onClick: () => {
+          if (isLoaded) {
+            setIsLightboxOpen(true);
+          }
+        },
+        disabled: !isLoaded,
+        "aria-busy": !isLoaded,
+        className: "group relative mx-auto flex w-full items-center justify-center overflow-hidden rounded-xl bg-black/[0.03] px-3 py-3 text-left transition-colors hover:bg-black/[0.05] disabled:cursor-wait disabled:hover:bg-black/[0.03] dark:bg-white/[0.03] dark:hover:bg-white/[0.05] dark:disabled:hover:bg-white/[0.03]",
+        style: {
+          ...imageFrameStyle,
+          ...!isLoaded ? { minHeight: "9rem" } : {}
+        },
+        children: /* @__PURE__ */ jsxRuntime.jsx(
+          "img",
+          {
+            src,
+            alt: alt || "",
+            className: `relative z-[1] block h-auto max-h-[22rem] w-full max-w-full rounded-lg object-contain transition-opacity duration-200 ${isLoaded ? "opacity-100" : "opacity-0"}`,
+            style: imageStyle,
+            onLoad: () => {
+              setHasError(false);
+              setIsLoaded(true);
+            },
+            onError: () => {
+              setIsLoaded(false);
+              setHasError(true);
+            }
+          }
+        )
+      }
+    ) }),
+    isLightboxOpen && isLoaded ? /* @__PURE__ */ jsxRuntime.jsx(
+      ImageLightbox,
+      {
+        src,
+        alt,
+        onClose: () => setIsLightboxOpen(false)
+      }
+    ) : null
+  ] });
+}
+function createMarkdownComponents(options = {}) {
+  return {
+    p: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("p", { className: "mb-3 last:mb-0 text-sm leading-relaxed", children }),
+    code: ({ className: codeClassName, children }) => {
+      const isInline = !codeClassName;
+      return isInline ? /* @__PURE__ */ jsxRuntime.jsx("code", { className: "payman-agent-code-inline rounded-md px-1.5 py-0.5 font-mono text-xs break-all", children }) : /* @__PURE__ */ jsxRuntime.jsx("code", { className: "payman-agent-code-block my-2 block overflow-x-auto rounded-lg p-3 font-mono text-xs whitespace-pre", children });
+    },
+    pre: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("pre", { className: "my-2 max-w-full overflow-x-auto rounded-lg", children }),
+    ul: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("ul", { className: "mb-3 ml-4 list-disc space-y-1 text-sm", children }),
+    ol: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("ol", { className: "mb-3 ml-4 list-decimal space-y-1 text-sm", children }),
+    li: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("li", { className: "text-sm leading-relaxed", children }),
+    h1: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h1", { className: "mt-4 mb-2 text-lg font-semibold first:mt-0", children }),
+    h2: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h2", { className: "mt-3 mb-2 text-base font-semibold first:mt-0", children }),
+    h3: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h3", { className: "mt-2 mb-1 text-sm font-semibold first:mt-0", children }),
+    strong: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("strong", { className: "font-semibold", children }),
+    em: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("em", { className: "italic", children }),
+    blockquote: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("blockquote", { className: "payman-agent-blockquote my-2 pl-4 italic", children }),
+    hr: () => /* @__PURE__ */ jsxRuntime.jsx("hr", { className: "payman-agent-hr my-4" }),
+    a: ({ href, children }) => /* @__PURE__ */ jsxRuntime.jsx(
+      "a",
+      {
+        href,
+        target: "_blank",
+        rel: "noopener noreferrer",
+        className: "payman-agent-link underline decoration-1 underline-offset-2",
+        children
+      }
+    ),
+    img: ({ src, alt }) => /* @__PURE__ */ jsxRuntime.jsx(
+      MarkdownImage,
+      {
+        src: typeof src === "string" ? src : void 0,
+        alt: typeof alt === "string" ? alt : void 0,
+        isResolving: options.isResolvingImages
+      }
+    ),
+    table: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("div", { className: "relative my-4 -mx-1 w-full overflow-x-auto", children: /* @__PURE__ */ jsxRuntime.jsx("table", { className: "payman-agent-table min-w-full caption-bottom overflow-hidden rounded-lg text-sm", children }) }),
+    thead: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("thead", { className: "payman-agent-thead [&_tr]:border-b", children }),
+    tbody: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("tbody", { className: "[&_tr:last-child]:border-0", children }),
+    tr: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("tr", { className: "payman-agent-tr border-b transition-colors", children }),
+    th: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("th", { className: "h-10 px-3 text-left align-middle text-xs font-medium whitespace-nowrap", children }),
+    td: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("td", { className: "p-3 align-middle text-sm whitespace-nowrap", children })
+  };
+}
 
 // src/utils/errorMessages.ts
 var WORKFLOW_FAILED = "WORKFLOW_FAILED";
@@ -453,6 +735,12 @@ function AgentMessage({
     ),
     [message.steps, currentExecutingStepId]
   );
+  const markdownRenderers = react.useMemo(
+    () => createMarkdownComponents({
+      isResolvingImages: message.isResolvingImages
+    }),
+    [message.isResolvingImages]
+  );
   const getStepsLabel = (streaming) => {
     const count = message.steps.length;
     const stepWord = count === 1 ? "step" : "steps";
@@ -640,7 +928,7 @@ function AgentMessage({
                             ReactMarkdown__default.default,
                             {
                               remarkPlugins: [remarkGfm__default.default],
-                              components: markdownComponents(),
+                              components: markdownRenderers,
                               children: isError ? conflictErrorMessage ?? FRIENDLY_ERROR_MESSAGE : content || (isStreaming ? "Thinking..." : isCancelled ? "Request was stopped." : "")
                             }
                           )
@@ -691,42 +979,6 @@ function AgentMessage({
   }
   return messageContent;
 }
-function markdownComponents(_isError) {
-  return {
-    p: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("p", { className: "mb-3 last:mb-0 text-sm leading-relaxed", children }),
-    code: ({ className: codeClassName, children }) => {
-      const isInline = !codeClassName;
-      return isInline ? /* @__PURE__ */ jsxRuntime.jsx("code", { className: "px-1.5 py-0.5 rounded-md text-xs font-mono break-all payman-agent-code-inline", children }) : /* @__PURE__ */ jsxRuntime.jsx("code", { className: "block p-3 rounded-lg text-xs font-mono overflow-x-auto my-2 whitespace-pre payman-agent-code-block", children });
-    },
-    pre: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("pre", { className: "my-2 overflow-x-auto max-w-full rounded-lg", children }),
-    ul: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("ul", { className: "list-disc ml-4 mb-3 space-y-1 text-sm", children }),
-    ol: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("ol", { className: "list-decimal ml-4 mb-3 space-y-1 text-sm", children }),
-    li: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("li", { className: "text-sm leading-relaxed", children }),
-    h1: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h1", { className: "text-lg font-semibold mb-2 mt-4 first:mt-0", children }),
-    h2: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h2", { className: "text-base font-semibold mb-2 mt-3 first:mt-0", children }),
-    h3: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("h3", { className: "text-sm font-semibold mb-1 mt-2 first:mt-0", children }),
-    strong: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("strong", { className: "font-semibold", children }),
-    em: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("em", { className: "italic", children }),
-    blockquote: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("blockquote", { className: "pl-4 my-2 italic payman-agent-blockquote", children }),
-    hr: () => /* @__PURE__ */ jsxRuntime.jsx("hr", { className: "my-4 payman-agent-hr" }),
-    a: ({ href, children }) => /* @__PURE__ */ jsxRuntime.jsx(
-      "a",
-      {
-        href,
-        target: "_blank",
-        rel: "noopener noreferrer",
-        className: "underline underline-offset-2 decoration-1 payman-agent-link",
-        children
-      }
-    ),
-    table: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("div", { className: "relative w-full overflow-x-auto my-4 -mx-1", children: /* @__PURE__ */ jsxRuntime.jsx("table", { className: "min-w-full caption-bottom text-sm rounded-lg overflow-hidden payman-agent-table", children }) }),
-    thead: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("thead", { className: "[&_tr]:border-b payman-agent-thead", children }),
-    tbody: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("tbody", { className: "[&_tr:last-child]:border-0", children }),
-    tr: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("tr", { className: "border-b transition-colors payman-agent-tr", children }),
-    th: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("th", { className: "h-10 px-3 text-left align-middle font-medium whitespace-nowrap text-xs", children }),
-    td: ({ children }) => /* @__PURE__ */ jsxRuntime.jsx("td", { className: "p-3 align-middle text-sm whitespace-nowrap", children })
-  };
-}
 function UserMessage({
   message,
   animated = false,
@@ -1780,6 +2032,11 @@ var PaymanChat = react.forwardRef(function PaymanChat2({
   const [inputValue, setInputValue] = react.useState("");
   const prevInputValueRef = react.useRef(inputValue);
   const [hasEverSentMessage, setHasEverSentMessage] = react.useState(false);
+  react.useEffect(() => {
+    if (config.sentryDsn) {
+      initSentryIfNeeded(config.sentryDsn);
+    }
+  }, [config.sentryDsn]);
   const chat = paymanTypescriptAskSdk.useChat(config, callbacks);
   const {
     messages,