@relevaince/document-viewer 0.1.1 → 0.2.0

package/dist/index.d.mts

@@ -10,24 +10,28 @@ type BBox = {
     x2: number;
     y2: number;
 };
+/**
+ * All supported document types. Use `getFileType(url)` when omitted.
+ */
+type ViewerFileType = "pdf" | "docx" | "image" | "json" | "eml";
 /**
  * Describes *what* to show and optionally *where* to focus.
  *
  * Consumers pass a `ViewerTarget` to `<DocumentViewer>` each time
- * the user clicks a citation.
+ * the user clicks a citation or opens a document.
  */
 type ViewerTarget = {
-    /** Public URL of the document (PDF / DOCX). */
+    /** Public URL of the document. */
     url: string;
     /** Explicit file type — auto-detected from URL extension when omitted. */
-    fileType?: "pdf" | "docx";
-    /** 1-indexed page to scroll to. */
+    fileType?: ViewerFileType;
+    /** 1-indexed page to scroll to (PDF). */
     page?: number;
-    /** Bounding box to highlight (normalised 0–1 coords). */
+    /** Bounding box to highlight (normalised 0–1 coords, PDF). */
     bbox?: BBox;
     /** Cited text snippet — for future text-search highlighting. */
     text?: string;
-    /** Display title shown in the viewer header. */
+    /** Display title shown in the viewer. */
     title?: string;
 };
 
@@ -70,6 +74,6 @@ declare function DocumentViewer({ target, pdfWorkerUrl, loadingComponent, errorC
  * Infer document type from URL extension.
  * Strips query-strings and fragments before matching.
  */
-declare function getFileType(url: string): "pdf" | "docx" | "unknown";
+declare function getFileType(url: string): ViewerFileType | "unknown";
 
-export { type BBox, DocumentViewer, type DocumentViewerProps, type ViewerTarget, getFileType };
+export { type BBox, DocumentViewer, type DocumentViewerProps, type ViewerFileType, type ViewerTarget, getFileType };

package/dist/index.d.ts

@@ -10,24 +10,28 @@ type BBox = {
     x2: number;
     y2: number;
 };
+/**
+ * All supported document types. Use `getFileType(url)` when omitted.
+ */
+type ViewerFileType = "pdf" | "docx" | "image" | "json" | "eml";
 /**
  * Describes *what* to show and optionally *where* to focus.
  *
  * Consumers pass a `ViewerTarget` to `<DocumentViewer>` each time
- * the user clicks a citation.
+ * the user clicks a citation or opens a document.
  */
 type ViewerTarget = {
-    /** Public URL of the document (PDF / DOCX). */
+    /** Public URL of the document. */
     url: string;
     /** Explicit file type — auto-detected from URL extension when omitted. */
-    fileType?: "pdf" | "docx";
-    /** 1-indexed page to scroll to. */
+    fileType?: ViewerFileType;
+    /** 1-indexed page to scroll to (PDF). */
     page?: number;
-    /** Bounding box to highlight (normalised 0–1 coords). */
+    /** Bounding box to highlight (normalised 0–1 coords, PDF). */
     bbox?: BBox;
     /** Cited text snippet — for future text-search highlighting. */
     text?: string;
-    /** Display title shown in the viewer header. */
+    /** Display title shown in the viewer. */
     title?: string;
 };
 
@@ -70,6 +74,6 @@ declare function DocumentViewer({ target, pdfWorkerUrl, loadingComponent, errorC
  * Infer document type from URL extension.
  * Strips query-strings and fragments before matching.
  */
-declare function getFileType(url: string): "pdf" | "docx" | "unknown";
+declare function getFileType(url: string): ViewerFileType | "unknown";
 
-export { type BBox, DocumentViewer, type DocumentViewerProps, type ViewerTarget, getFileType };
+export { type BBox, DocumentViewer, type DocumentViewerProps, type ViewerFileType, type ViewerTarget, getFileType };