@osdk/react-components 0.2.0-beta.23 → 0.2.0-beta.25

package/build/types/pdf-viewer/hooks/usePdfHighlightMode.d.ts

@@ -0,0 +1,35 @@
+import type { PDFDocumentProxy } from "pdfjs-dist";
+import type { PDFViewer } from "pdfjs-dist/web/pdf_viewer.mjs";
+import type { RefObject } from "react";
+import type { PdfRect, PdfTextHighlightEvent } from "../types.js";
+export interface UsePdfHighlightModeOptions {
+	pdfViewerRef: RefObject<PDFViewer | null>;
+	document: PDFDocumentProxy | undefined;
+	enabled: boolean;
+	onTextHighlight?: (event: PdfTextHighlightEvent) => void;
+	onHighlightDelete?: (event: PdfTextHighlightEvent) => void;
+}
+export interface UsePdfHighlightModeResult {
+	highlightModeActive: boolean;
+	toggleHighlightMode: () => void;
+}
+/**
+* Converts an RGB array (0.0–1.0 per channel) to a CSS hex color string.
+*/
+export declare function rgbArrayToHex(color: number[]): string;
+/**
+* Converts quadPoints (PDF spec format) back to PdfRect[].
+* QuadPoints are 8 values per quad: [x1,y1, x2,y2, x3,y3, x4,y4]
+* representing the four corners of each highlight rect.
+*
+* PDF.js highlight editor produces axis-aligned quads with ordering:
+*   (x1,y1)=top-left, (x2,y2)=top-right, (x3,y3)=bottom-left, (x4,y4)=bottom-right
+* We derive the bounding rect from x1, y1 (top), x2 (right edge), y3 (bottom).
+*/
+export declare function quadPointsToRects(quadPoints: Float32Array): PdfRect[];
+/**
+* Hook that manages the PDF.js built-in highlight annotation editor mode.
+* When active, users can select text to create highlights.
+* A callback fires with the annotation details for persistence.
+*/
+export declare function usePdfHighlightMode({ pdfViewerRef, document, enabled, onTextHighlight, onHighlightDelete }: UsePdfHighlightModeOptions): UsePdfHighlightModeResult;

package/build/types/pdf-viewer/hooks/usePdfHighlightMode.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAiBA,cAAc,wBAAwB,YAAa;AACnD,cAAc,iBAAiB,+BAAgC;AAC/D,cAAc,iBAAiB,OAAQ;AAEvC,cAAc,SAAS,6BAA6B,aAAc;AAElE,iBAAiB,2BAA2B;CAC1C,cAAc,UAAU;CACxB,UAAU;CACV;CACA,mBAAmBA,OAAO;CAC1B,qBAAqBA,OAAO;AAC7B;AAED,iBAAiB,0BAA0B;CACzC;CACA;AACD;;;;AAKD,OAAO,iBAAS,cAAcC;;;;;;;;;;AAkB9B,OAAO,iBAAS,kBACdC,YAAY,eACX;;;;;;AAuBH,OAAO,iBAAS,oBAAoB,EAClC,cACA,UACA,SACA,iBACA,mBAC2B,EAA1B,6BAA6B","names":["event: PdfTextHighlightEvent","color: number[]","quadPoints: Float32Array"],"sources":["../../../../src/pdf-viewer/hooks/usePdfHighlightMode.ts"],"version":3,"file":"usePdfHighlightMode.d.ts"}

package/build/types/pdf-viewer/hooks/usePdfViewer.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,wBAAwB,YAAa;AACnD,SACE,UACA,mBAEA,iBACK,+BAAgC;AACvC,cAAc,iBAAiB,OAAQ;AAIvC,iBAAiB,mBAAmB;CAClC,cAAc,UAAU;CACxB,aAAa,UAAU;CACvB,mBAAmB,UAAU;AAC9B;AAED,OAAO,iBAAS,aACdA,cAAc,UAAU,wBACxBC,WAAW,UAAU,wBACrBC,UAAU,8BACVC,uBACAC,uBACC","names":["containerRef: RefObject<HTMLDivElement | null>","viewerRef: RefObject<HTMLDivElement | null>","document: PDFDocumentProxy | undefined","initialScale?: number","initialPage?: number"],"sources":["../../../../src/pdf-viewer/hooks/usePdfViewer.ts"],"version":3,"file":"usePdfViewer.d.ts"}
+{"mappings":"AAiBA,cAAc,wBAAwB,YAAa;AACnD,SACE,UACA,mBAEA,iBACK,+BAAgC;AACvC,cAAc,iBAAiB,OAAQ;AAIvC,iBAAiB,mBAAmB;CAClC,cAAc,UAAU;CACxB,aAAa,UAAU;CACvB,mBAAmB,UAAU;AAC9B;AAED,OAAO,iBAAS,aACdA,cAAc,UAAU,wBACxBC,WAAW,UAAU,wBACrBC,UAAU,8BACVC,uBACAC,uBACC","names":["containerRef: RefObject<HTMLDivElement | null>","viewerRef: RefObject<HTMLDivElement | null>","document: PDFDocumentProxy | undefined","initialScale?: number","initialPage?: number"],"sources":["../../../../src/pdf-viewer/hooks/usePdfViewer.ts"],"version":3,"file":"usePdfViewer.d.ts"}

package/build/types/pdf-viewer/types.d.ts

@@ -10,27 +10,49 @@ export interface OutlineItem {
 	italic: boolean;
 }
 /** The visual style of an annotation rendered on the PDF. */
-export type AnnotationType = "highlight" | "underline" | "comment" | "pin";
-/** A single annotation positioned on a specific page of the PDF. */
-export interface PdfAnnotation {
+export type AnnotationType = "highlight" | "underline" | "comment" | "pin" | "custom";
+/** A rectangle in PDF coordinate space (origin: bottom-left of page). */
+export interface PdfRect {
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+}
+/** Props passed to a custom annotation renderer. */
+export interface PdfAnnotationRenderProps {
+	annotation: PdfAnnotation;
+	scale: number;
+	pageHeight: number;
+}
+/** Common fields shared by all annotation types. */
+interface PdfAnnotationBase {
 	/** Unique identifier for this annotation */
 	id: string;
-	/** The type of annotation to render */
-	type: AnnotationType;
 	/** Page number (1-indexed) */
 	page: number;
 	/** Coordinates in PDF points (origin: bottom-left of page) */
-	rect: {
-		x: number
-		y: number
-		width: number
-		height: number
-	};
+	rect: PdfRect;
+	/** Additional rects for multi-line text highlights. When present, all rects are rendered. */
+	rects?: PdfRect[];
 	/** Optional label or tooltip text */
 	label?: string;
 	/** Optional color override (CSS color string) */
 	color?: string;
 }
+/** A built-in annotation type (highlight, underline, comment, pin). */
+interface PdfStandardAnnotation extends PdfAnnotationBase {
+	/** The type of annotation to render */
+	type: "highlight" | "underline" | "comment" | "pin";
+}
+/** A custom annotation with a user-provided renderer. */
+export interface PdfCustomAnnotation extends PdfAnnotationBase {
+	/** Must be "custom" for custom-rendered annotations */
+	type: "custom";
+	/** Render function for the custom annotation content (required for custom type) */
+	render: (props: PdfAnnotationRenderProps) => React.ReactNode;
+}
+/** A single annotation positioned on a specific page of the PDF. */
+export type PdfAnnotation = PdfStandardAnnotation | PdfCustomAnnotation;
 /** Result passed to the {@link PdfViewerProps.onDownload} callback. */
 export type PdfDownloadResult = {
 	success: true
@@ -39,12 +61,25 @@ export type PdfDownloadResult = {
 	success: false
 	error: Error
 };
+/** Possible values for a PDF form field. */
+export type PdfFormFieldValue = string | boolean | string[];
+/** Data emitted when the user creates a text highlight via the highlight editor. */
+export interface PdfTextHighlightEvent {
+	/** Page number (1-indexed) */
+	page: number;
+	/** Bounding rects in PDF coordinate space (bottom-left origin) */
+	rects: PdfRect[];
+	/** The selected text content */
+	selectedText: string;
+	/** Highlight color as CSS color string */
+	color: string;
+}
 /** Props for the {@link PdfViewer} component. */
 export interface PdfViewerProps {
 	/** PDF source — URL string or ArrayBuffer */
 	src: string | ArrayBuffer;
-	/** Annotations to overlay on the PDF, keyed by page number (1-indexed) */
-	annotations?: Record<number, PdfAnnotation[]>;
+	/** Annotations to overlay on the PDF */
+	annotations?: PdfAnnotation[];
 	/**
 	* Callback fired when an annotation is clicked.
 	*
@@ -59,6 +94,26 @@ export interface PdfViewerProps {
 	* @returns void
 	*/
 	onDownload?: (result: PdfDownloadResult) => void;
+	/**
+	* Whether the highlight toggle button is shown in the toolbar.
+	* @default false
+	*/
+	enableHighlight?: boolean;
+	/**
+	* Callback fired when the user creates a text highlight.
+	* Only fires when highlight mode is active.
+	*
+	* @param event - The highlight event with page, rects, text, and color
+	* @returns void
+	*/
+	onTextHighlight?: (event: PdfTextHighlightEvent) => void;
+	/**
+	* Callback fired when the user deletes a highlight via the PDF.js editor UI.
+	*
+	* @param event - The highlight event that was deleted
+	* @returns void
+	*/
+	onHighlightDelete?: (event: PdfTextHighlightEvent) => void;
 	/** Initial page number (1-indexed, default 1) */
 	initialPage?: number;
 	/** Initial zoom scale (default 1.0) */
@@ -81,6 +136,28 @@ export interface PdfViewerProps {
 	* If omitted, no icons are rendered.
 	*/
 	outlineIcons?: Partial<Record<number, React.ComponentType>>;
+	/**
+	* Initial form field values keyed by field name. Applied when the document loads.
+	* Use this to pre-populate form fields when resuming a previously edited PDF.
+	*/
+	formData?: Record<string, PdfFormFieldValue>;
+	/**
+	* Callback fired when the user clicks the save button in the toolbar.
+	* Receives all current form field values keyed by field name.
+	*
+	* @param data - All form field values keyed by field name
+	* @returns void
+	*/
+	onFormSubmit?: (data: Record<string, PdfFormFieldValue>) => void;
+	/**
+	* Callback fired when any form field value changes.
+	*
+	* @param fieldName - The name of the field that changed
+	* @param value - The new value
+	* @returns void
+	*/
+	onFormChange?: (fieldName: string, value: PdfFormFieldValue) => void;
 	/** Additional CSS class name for the root element */
 	className?: string;
 }
+export {};

package/build/types/pdf-viewer/types.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,YAAY,WAAW,OAAQ;;AAG/B,YAAY,cAAc,eAAe;;AAGzC,iBAAiB,YAAY;CAC3B;CACA;CACA;CACA;CACA;AACD;;AAGD,YAAY,iBAAiB,cAAc,cAAc,YAAY;;AAGrE,iBAAiB,cAAc;;CAE7B;;CAEA,MAAM;;CAEN;;CAEA,MAAM;EAAE;EAAW;EAAW;EAAe;CAAgB;;CAE7D;;CAEA;AACD;;AAGD,YAAY,oBACR;CAAE,SAAS;CAAM;AAAkB,IACnC;CAAE,SAAS;CAAO,OAAO;AAAO;;AAGpC,iBAAiB,eAAe;;CAE9B,cAAc;;CAEd,cAAc,eAAe;;;;;;;CAO7B,qBAAqBA,YAAY;;;;;;;CAOjC,cAAcC,QAAQ;;CAEtB;;CAEA;;CAEA;;;;;CAKA;;;;;CAKA,cAAc;;;;;;CAMd,eAAe,QAAQ,eAAe,MAAM;;CAE5C;AACD","names":["annotation: PdfAnnotation","result: PdfDownloadResult"],"sources":["../../../src/pdf-viewer/types.ts"],"version":3,"file":"types.d.ts"}
+{"mappings":"AAgBA,YAAY,WAAW,OAAQ;;AAG/B,YAAY,cAAc,eAAe;;AAGzC,iBAAiB,YAAY;CAC3B;CACA;CACA;CACA;CACA;AACD;;AAGD,YAAY,iBACR,cACA,cACA,YACA,QACA;;AAGJ,iBAAiB,QAAQ;CACvB;CACA;CACA;CACA;AACD;;AAGD,iBAAiB,yBAAyB;CACxC,YAAY;CACZ;CACA;AACD;;UAGS,kBAAkB;;CAE1B;;CAEA;;CAEA,MAAM;;CAEN,QAAQ;;CAER;;CAEA;AACD;;UAGS,8BAA8B,kBAAkB;;CAExD,MAAM,cAAc,cAAc,YAAY;AAC/C;;AAGD,iBAAiB,4BAA4B,kBAAkB;;CAE7D,MAAM;;CAEN,SAASA,OAAO,6BAA6B,MAAM;AACpD;;AAGD,YAAY,gBAAgB,wBAAwB;;AAGpD,YAAY,oBACR;CAAE,SAAS;CAAM;AAAkB,IACnC;CAAE,SAAS;CAAO,OAAO;AAAO;;AAGpC,YAAY;;AAGZ,iBAAiB,sBAAsB;;CAErC;;CAEA,OAAO;;CAEP;;CAEA;AACD;;AAGD,iBAAiB,eAAe;;CAE9B,cAAc;;CAEd,cAAc;;;;;;;CAOd,qBAAqBC,YAAY;;;;;;;CAOjC,cAAcC,QAAQ;;;;;CAKtB;;;;;;;;CAQA,mBAAmBC,OAAO;;;;;;;CAO1B,qBAAqBA,OAAO;;CAE5B;;CAEA;;CAEA;;;;;CAKA;;;;;CAKA,cAAc;;;;;;CAMd,eAAe,QAAQ,eAAe,MAAM;;;;;CAK5C,WAAW,eAAe;;;;;;;;CAQ1B,gBAAgBC,MAAM,eAAe;;;;;;;;CAQrC,gBAAgBC,mBAAmBC,OAAO;;CAE1C;AACD","names":["props: PdfAnnotationRenderProps","annotation: PdfAnnotation","result: PdfDownloadResult","event: PdfTextHighlightEvent","data: Record<string, PdfFormFieldValue>","fieldName: string","value: PdfFormFieldValue"],"sources":["../../../src/pdf-viewer/types.ts"],"version":3,"file":"types.d.ts"}

package/build/types/public/experimental.d.ts

@@ -12,7 +12,7 @@ export { BaseTable } from "../object-table/Table.js";
 export { ColumnConfigDialog } from "../object-table/ColumnConfigDialog.js";
 export type { ColumnConfigDialogProps, ColumnConfigOptions } from "../object-table/ColumnConfigDialog.js";
 export { BasePdfViewer } from "../pdf-viewer/PdfViewer.js";
-export type { AnnotationType, PdfAnnotation, PdfDownloadResult, PdfViewerProps, SidebarMode } from "../pdf-viewer/types.js";
+export type { AnnotationType, PdfAnnotation, PdfAnnotationRenderProps, PdfCustomAnnotation, PdfDownloadResult, PdfFormFieldValue, PdfRect, PdfTextHighlightEvent, PdfViewerProps, SidebarMode } from "../pdf-viewer/types.js";
 export { PdfViewerAnnotationLayer, type PdfViewerAnnotationLayerProps } from "../pdf-viewer/components/PdfViewerAnnotationLayer.js";
 export { PdfViewerContent, type PdfViewerContentProps } from "../pdf-viewer/components/PdfViewerContent.js";
 export { PdfViewerOutlineSidebar, type PdfViewerOutlineSidebarProps } from "../pdf-viewer/components/PdfViewerOutlineSidebar.js";
@@ -20,7 +20,10 @@ export { PdfViewerSearchBar, type PdfViewerSearchBarProps } from "../pdf-viewer/
 export { PdfViewerSidebar, type PdfViewerSidebarProps } from "../pdf-viewer/components/PdfViewerSidebar.js";
 export { PdfViewerToolbar, type PdfViewerToolbarProps } from "../pdf-viewer/components/PdfViewerToolbar.js";
 export { type AnnotationPortalTarget, usePdfAnnotationPortals } from "../pdf-viewer/hooks/usePdfAnnotationPortals.js";
+export { usePdfAnnotationsByPage } from "../pdf-viewer/hooks/usePdfAnnotationsByPage.js";
 export { usePdfDocument } from "../pdf-viewer/hooks/usePdfDocument.js";
+export { usePdfFormFields, type UsePdfFormFieldsOptions, type UsePdfFormFieldsResult } from "../pdf-viewer/hooks/usePdfFormFields.js";
+export { usePdfHighlightMode, type UsePdfHighlightModeOptions, type UsePdfHighlightModeResult } from "../pdf-viewer/hooks/usePdfHighlightMode.js";
 export { usePdfOutline } from "../pdf-viewer/hooks/usePdfOutline.js";
 export { usePdfViewer, type UsePdfViewerResult } from "../pdf-viewer/hooks/usePdfViewer.js";
 export { usePdfViewerSearch, type UsePdfViewerSearchResult } from "../pdf-viewer/hooks/usePdfViewerSearch.js";

package/build/types/public/experimental.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,SAAS,sBAAsB;AAC/B,cACE,qBACA,yBACK;AACP,SAAS,kBAAkB;AAE3B,cACE,uBACA,uBACK;AACP,cACE,qBACA,qBACA,aACA,gCACK;AACP,SACE,yBACA,6BACK;AAGP,SAAS,mBAAmB;AAC5B,cACE,kBACA,yBACA,qBACA,uBACA,kBACA,uBACA,wBACK;AACP,cAAc,oBAAoB;AAGlC,cAAc,sBAAsB;AACpC,SAAS,iBAAiB;AAE1B,SAAS,0BAA0B;AACnC,cACE,yBACA,2BACK;AAGP,SAAS,qBAAqB;AAC9B,cACE,gBACA,eACA,mBACA,gBACA,mBACK;AAGP,SACE,+BACK,qCACA;AACP,SACE,uBACK,6BACA;AACP,SACE,8BACK,oCACA;AACP,SACE,yBACK,+BACA;AACP,SACE,uBACK,6BACA;AACP,SACE,uBACK,6BACA;AAGP,cACO,wBACL,+BACK;AACP,SAAS,sBAAsB;AAC/B,SAAS,qBAAqB;AAC9B,SACE,mBACK,0BACA;AACP,SACE,yBACK,gCACA;AACP,SAAS,wBAAwB;AACjC,cAAc,mBAAmB;AAGjC,SACE,uBACK,8BACA,8BACA;AACP,SACE,wBACK,+BACA,+BACA;AAGP,SACE,gBACK,2BACA;AAEP,SAAS,kBAAkB;AAC3B,cACE,iBACA,eACA,WACA,iBACK;AACP,SAAS,gBAAgB;AACzB,cACE,kBACA,oBACA,kBACA,0BACA,oBACA,gBACA,gBACA,iBACA,qBACA,sBACA,uBACA,qBACA,QACA,wBACA,yBACA,oBACA,2BACK","names":[],"sources":["../../../src/public/experimental.ts"],"version":3,"file":"experimental.d.ts"}
+{"mappings":"AAgBA,SAAS,sBAAsB;AAC/B,cACE,qBACA,yBACK;AACP,SAAS,kBAAkB;AAE3B,cACE,uBACA,uBACK;AACP,cACE,qBACA,qBACA,aACA,gCACK;AACP,SACE,yBACA,6BACK;AAGP,SAAS,mBAAmB;AAC5B,cACE,kBACA,yBACA,qBACA,uBACA,kBACA,uBACA,wBACK;AACP,cAAc,oBAAoB;AAGlC,cAAc,sBAAsB;AACpC,SAAS,iBAAiB;AAE1B,SAAS,0BAA0B;AACnC,cACE,yBACA,2BACK;AAGP,SAAS,qBAAqB;AAC9B,cACE,gBACA,eACA,0BACA,qBACA,mBACA,mBACA,SACA,uBACA,gBACA,mBACK;AAGP,SACE,+BACK,qCACA;AACP,SACE,uBACK,6BACA;AACP,SACE,8BACK,oCACA;AACP,SACE,yBACK,+BACA;AACP,SACE,uBACK,6BACA;AACP,SACE,uBACK,6BACA;AAGP,cACO,wBACL,+BACK;AACP,SAAS,+BAA+B;AACxC,SAAS,sBAAsB;AAC/B,SACE,uBACK,8BACA,8BACA;AACP,SACE,0BACK,iCACA,iCACA;AACP,SAAS,qBAAqB;AAC9B,SACE,mBACK,0BACA;AACP,SACE,yBACK,gCACA;AACP,SAAS,wBAAwB;AACjC,cAAc,mBAAmB;AAGjC,SACE,uBACK,8BACA,8BACA;AACP,SACE,wBACK,+BACA,+BACA;AAGP,SACE,gBACK,2BACA;AAEP,SAAS,kBAAkB;AAC3B,cACE,iBACA,eACA,WACA,iBACK;AACP,SAAS,gBAAgB;AACzB,cACE,kBACA,oBACA,kBACA,0BACA,oBACA,gBACA,gBACA,iBACA,qBACA,sBACA,uBACA,qBACA,QACA,wBACA,yBACA,oBACA,2BACK","names":[],"sources":["../../../src/public/experimental.ts"],"version":3,"file":"experimental.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/react-components",
-  "version": "0.2.0-beta.23",
+  "version": "0.2.0-beta.25",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -78,11 +78,11 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "typescript": "~5.5.4",
-    "@osdk/api": "2.8.0-beta.27",
-    "@osdk/monorepo.api-extractor": "~0.7.0-beta.1",
+    "@osdk/api": "2.8.0-beta.28",
+    "@osdk/client": "2.8.0-beta.28",
     "@osdk/monorepo.tsconfig": "~0.7.0-beta.1",
-    "@osdk/client": "2.8.0-beta.27",
-    "@osdk/react": "0.10.0-beta.11"
+    "@osdk/monorepo.api-extractor": "~0.7.0-beta.1",
+    "@osdk/react": "0.10.0-beta.13"
   },
   "publishConfig": {
     "access": "public"

package/build/browser/action-form/fields/TextInputField.module.css.js

@@ -1,6 +0,0 @@
-// CSS Module proxy for TextInputField.module.css
-const styles = {
-  "osdkTextInput": "TextInputField-module__osdkTextInput___Mm2e5yAE"
-};
-
-export default styles;