@epam/ai-dial-attachment-canvas 0.0.0-dev.0

package/models/attachment-canvas.d.ts

@@ -0,0 +1,155 @@
+import { CodeBlockTheme } from '@epam/ai-dial-chat-shared';
+import { SidebarPanelStyles } from '@epam/ai-dial-sidebar';
+import { InputHighlightData } from '@epam/pdf-highlighter-kit';
+import { CSSProperties } from 'react';
+import { AttachmentContentType } from '../types/attachment-canvas';
+/** Content payload for plain-text attachments. */
+export interface PlainTextCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.PlainText;
+    /** The raw text to display. */
+    text: string;
+}
+/** Content payload for image attachments. */
+export interface ImageCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.Image;
+    /** URL of the image to display (object URL or resolved download URL). */
+    url: string;
+}
+/** Content payload for Markdown file attachments. */
+export interface MarkdownCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.Markdown;
+    /** Raw Markdown string to render. */
+    text: string;
+}
+/** Content payload for JSON file attachments. */
+export interface JsonCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.Json;
+    /** Already-parsed JSON value. The lib never calls JSON.parse. */
+    value: unknown;
+}
+/** Content payload for PDF file attachments. */
+export interface PdfCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.Pdf;
+    /** Resolved download URL or object URL for the PDF file. */
+    url: string;
+    /** Highlight regions to render over the PDF pages. */
+    highlights?: InputHighlightData[];
+    /** ID of the highlight to scroll to and select on initial load. */
+    selectedHighlightId?: string;
+}
+/** Content payload for attachments whose format cannot be previewed. */
+export interface UnsupportedCanvasContent {
+    /** Discriminates the content type to select the correct renderer. */
+    type: AttachmentContentType.Unsupported;
+    /** Remote URL used to download the file even though it cannot be previewed. */
+    url?: string;
+}
+/** The content payload passed to AttachmentCanvas. */
+export type AttachmentCanvasContent = PlainTextCanvasContent | ImageCanvasContent | MarkdownCanvasContent | JsonCanvasContent | PdfCanvasContent | UnsupportedCanvasContent;
+/** Themeable color overrides for the AttachmentCanvas content body. */
+export interface AttachmentCanvasColors {
+    /** Primary text color for the content body. */
+    text?: string;
+}
+/** Themeable typography overrides for the AttachmentCanvas content body. */
+export interface AttachmentCanvasTypography {
+    /** CSS font-family value. */
+    fontFamily?: string;
+    /** CSS font-size value. */
+    fontSize?: string;
+    /** CSS font-weight value. */
+    fontWeight?: string | number;
+    /** CSS line-height value. */
+    lineHeight?: string | number;
+    /** CSS letter-spacing value. */
+    letterSpacing?: string;
+    /**
+     * A single CSS utility class applied to the content body instead of
+     * individual typography vars. When set, individual typography fields
+     * are ignored.
+     */
+    fontClassName?: string;
+}
+/** Combined style override prop for AttachmentCanvas. */
+export interface AttachmentCanvasStyles {
+    /** Color overrides for the content body, applied as CSS custom properties. */
+    colors?: AttachmentCanvasColors;
+    /** Typography overrides for the content body. */
+    typography?: AttachmentCanvasTypography;
+    /** Extra class name(s) merged onto the scrollable content body element. */
+    bodyClassName?: string;
+    /**
+     * Arbitrary CSS custom properties applied inline to the content body.
+     * Merged after the typed color/typography vars, so they can override them.
+     */
+    cssVars?: CSSProperties;
+    /** Style overrides forwarded to the underlying SidebarPanel (panel chrome). */
+    panelStyles?: SidebarPanelStyles;
+}
+/** Props for the AttachmentCanvas component. */
+export interface AttachmentCanvasProps {
+    /** Controls visibility of the side panel. */
+    isOpen: boolean;
+    /** Called when the user activates the built-in close button. */
+    onClose: () => void;
+    /** The attachment content to render inside the canvas. */
+    content: AttachmentCanvasContent;
+    /** File name displayed as the panel title. */
+    fileName?: string;
+    /** Accessible label for the panel region. */
+    ariaLabel: string;
+    /** Accessible label for the close button. Defaults to `'Close'`. */
+    closeLabel?: string;
+    /** Called when the user activates the download button. When omitted the download button is hidden. Hidden automatically when content type is `Unsupported`. */
+    onDownload?: () => void;
+    /** Called when the user activates the copy-text button. When omitted the button is hidden. Only relevant when content type is `PlainText`. */
+    onCopyText?: () => void;
+    /** Called when the user activates the copy-as-markdown button. When omitted the button is hidden. Only relevant when content type is `Markdown`. */
+    onCopyMarkdown?: () => void;
+    /** Called when the user activates the copy-JSON button. When omitted the button is hidden. Only relevant when content type is `Json`. */
+    onCopyJson?: () => void;
+    /** Message shown in the canvas body when the content type is `Unsupported`. Defaults to `'Preview is not supported for this file'`. */
+    unsupportedLabel?: string;
+    /** Accessible label for the download button. Defaults to `'Download'`. */
+    downloadLabel?: string;
+    /** Tooltip and accessible label for the copy-text button in its default state. Defaults to `'Copy text'`. */
+    copyTextLabel?: string;
+    /** Tooltip and accessible label for the copy-text button after a successful copy. Defaults to `'Copied!'`. */
+    copiedTextLabel?: string;
+    /** Tooltip and accessible label for the copy-as-markdown button in its default state. Defaults to `'Copy as Markdown'`. */
+    copyMarkdownLabel?: string;
+    /** Tooltip and accessible label for the copy-as-markdown button after a successful copy. Defaults to `'Copied!'`. */
+    copiedMarkdownLabel?: string;
+    /** Tooltip and accessible label for the copy-JSON button in its default state. Defaults to `'Copy as JSON'`. */
+    copyJsonLabel?: string;
+    /** Tooltip and accessible label for the copy-JSON button after a successful copy. Defaults to `'Copied!'`. */
+    copiedJsonLabel?: string;
+    /** Whether the viewport is in mobile breakpoint — disables drag-to-resize. */
+    isMobile?: boolean;
+    /** Initial panel width in pixels (when resizable). Defaults to `min(maxWidth, 2/3 of viewport width)`. */
+    defaultWidth?: number;
+    /** Minimum panel width in pixels (when resizable). Defaults to `320`. */
+    minWidth?: number;
+    /** Maximum panel width in pixels (when resizable). Defaults to `1500`. */
+    maxWidth?: number;
+    /** Called with the new width in pixels after the user finishes a resize drag. */
+    onResizeStop?: (width: number) => void;
+    /** Style overrides for the content body and the underlying SidebarPanel chrome. */
+    styles?: AttachmentCanvasStyles;
+    /** Extra class name(s) merged onto the panel width wrapper. */
+    className?: string;
+    /** Syntax highlight color theme forwarded to MarkdownRenderer code blocks. */
+    codeBlockTheme?: CodeBlockTheme;
+    /**
+     * Fetches a PDF file by URL and returns its bytes as a `Blob`. Used when
+     * content type is `Pdf` to load the file before rendering. Defaults to a
+     * plain `fetch` if not provided.
+     */
+    loadPdf?: (url: string) => Promise<Blob>;
+}
+//# sourceMappingURL=attachment-canvas.d.ts.map

package/models/attachment-canvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachment-canvas.d.ts","sourceRoot":"","sources":["../../src/models/attachment-canvas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,kDAAkD;AAClD,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC;IACtC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,6CAA6C;AAC7C,MAAM,WAAW,kBAAkB;IACjC,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC;IAClC,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAC;CACb;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC;IACrC,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IACjC,iEAAiE;IACjE,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,gDAAgD;AAChD,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,GAAG,CAAC;IAChC,4DAA4D;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAClC,mEAAmE;IACnE,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,wEAAwE;AACxE,MAAM,WAAW,wBAAwB;IACvC,qEAAqE;IACrE,IAAI,EAAE,qBAAqB,CAAC,WAAW,CAAC;IACxC,+EAA+E;IAC/E,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,sDAAsD;AACtD,MAAM,MAAM,uBAAuB,GAC/B,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,GACrB,iBAAiB,GACjB,gBAAgB,GAChB,wBAAwB,CAAC;AAE7B,uEAAuE;AACvE,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,4EAA4E;AAC5E,MAAM,WAAW,0BAA0B;IACzC,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,gCAAgC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yDAAyD;AACzD,MAAM,WAAW,sBAAsB;IACrC,8EAA8E;IAC9E,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,iDAAiD;IACjD,UAAU,CAAC,EAAE,0BAA0B,CAAC;IACxC,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,MAAM,EAAE,OAAO,CAAC;IAChB,gEAAgE;IAChE,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,0DAA0D;IAC1D,OAAO,EAAE,uBAAuB,CAAC;IACjC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+JAA+J;IAC/J,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,8IAA8I;IAC9I,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,oJAAoJ;IACpJ,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,yIAAyI;IACzI,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,uIAAuI;IACvI,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6GAA6G;IAC7G,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8GAA8G;IAC9G,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,2HAA2H;IAC3H,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qHAAqH;IACrH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gHAAgH;IAChH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8GAA8G;IAC9G,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,mFAAmF;IACnF,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@epam/ai-dial-attachment-canvas",
+  "version": "0.0.0-dev.0",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    "./styles.css": "./style.css",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "peerDependencies": {
+    "@epam/ai-dial-chat-shared": "0.0.0-dev.0",
+    "@epam/ai-dial-sidebar": "0.0.0-dev.0",
+    "@epam/ai-dial-ui-kit": "0.12.0-dev.21",
+    "@epam/pdf-highlighter-kit": ">=0.0.14",
+    "@tabler/icons-react": "^3.44.0",
+    "react": "^19.0.0",
+    "react-json-view-lite": "^2.5.0",
+    "@epam/ai-dial-react-pdf-highlighter": "0.2.0-dev.17"
+  },
+  "dependencies": {}
+}

package/test-setup.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test-setup.d.ts.map

package/test-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-setup.d.ts","sourceRoot":"","sources":["../src/test-setup.ts"],"names":[],"mappings":""}

package/types/attachment-canvas.d.ts

@@ -0,0 +1,10 @@
+/** The type of content the canvas can display. */
+export declare enum AttachmentContentType {
+    PlainText = "plain_text",
+    Image = "image",
+    Markdown = "markdown",
+    Json = "json",
+    Pdf = "pdf",
+    Unsupported = "unsupported"
+}
+//# sourceMappingURL=attachment-canvas.d.ts.map

package/types/attachment-canvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachment-canvas.d.ts","sourceRoot":"","sources":["../../src/types/attachment-canvas.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,oBAAY,qBAAqB;IAC/B,SAAS,eAAe;IACxB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,WAAW,gBAAgB;CAC5B"}

package/utils/content.d.ts

@@ -0,0 +1,6 @@
+import { UnsupportedCanvasContent } from '../models/attachment-canvas';
+/** Returns true if the file name has an extension known to be text-previewable. */
+export declare const isTextPreviewable: (name: string) => boolean;
+/** Creates an unsupported-format content payload. */
+export declare const createUnsupportedCanvasContent: (url?: string) => UnsupportedCanvasContent;
+//# sourceMappingURL=content.d.ts.map

package/utils/content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/utils/content.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAG5E,mFAAmF;AACnF,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,KAAG,OAIhD,CAAC;AAEF,qDAAqD;AACrD,eAAO,MAAM,8BAA8B,GACzC,MAAM,MAAM,KACX,wBAGD,CAAC"}

package/utils/download.d.ts

@@ -0,0 +1,8 @@
+import { AttachmentCanvasContent } from '../models/attachment-canvas';
+/** Returns true if the given canvas content can be downloaded. */
+export declare const isDownloadable: (content: AttachmentCanvasContent) => boolean;
+/** Fetches a URL and returns its response body as a `Blob`. */
+export declare const fetchBlobFromUrl: (url: string) => Promise<Blob>;
+/** Triggers a browser download for the given canvas content. */
+export declare const downloadAttachmentContent: (content: AttachmentCanvasContent, fileName?: string) => void;
+//# sourceMappingURL=download.d.ts.map

package/utils/download.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/utils/download.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAG3E,kEAAkE;AAClE,eAAO,MAAM,cAAc,GAAI,SAAS,uBAAuB,KAAG,OAWjE,CAAC;AAEF,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB,GAAU,KAAK,MAAM,KAAG,OAAO,CAAC,IAAI,CAIhE,CAAC;AAEF,gEAAgE;AAChE,eAAO,MAAM,yBAAyB,GACpC,SAAS,uBAAuB,EAChC,WAAW,MAAM,KAChB,IAwCF,CAAC"}