@papyrus-sdk/ui-react-native 0.2.35-beta.1 → 0.2.35-beta.11

package/README.md

@@ -5,10 +5,12 @@ React Native UI components for Papyrus viewers.
 ## Install
 
 ```bash
-npm install @papyrus-sdk/ui-react-native @papyrus-sdk/engine-native @papyrus-sdk/core @papyrus-sdk/types react-native-gesture-handler
+npm install @papyrus-sdk/ui-react-native @papyrus-sdk/engine-native @papyrus-sdk/core @papyrus-sdk/types react-native-gesture-handler react-native-reanimated@^3.19.5
 ```
 
-`@papyrus-sdk/core`, `@papyrus-sdk/types`, and `react-native-gesture-handler` are required peer dependencies.
+`@papyrus-sdk/core`, `@papyrus-sdk/types`, `react-native-gesture-handler`, and `react-native-reanimated` (3.19.5+) are required peer dependencies.
+
+Configure Reanimated 3 in the host app, with `react-native-reanimated/plugin` last in the Babel plugin list. The native iOS PDF annotation mode animates the Topbar and dock; it respects the system Reduce Motion setting. While drawing, Concluir/Done closes the ink session through the existing store/native flush flow. The first Back press finishes drawing without leaving the reader; the next press navigates back.
 
 Wrap the app root with `GestureHandlerRootView` before rendering Papyrus components:
 
@@ -160,3 +162,7 @@ If large files fail to load or crash on mobile:
   - Runtime EPUB open/ready timeout: `180000ms`
   - Runtime EPUB display timeout: `30000ms`
 - For very large EPUBs, first-open can take longer on mid-tier Android. This is expected due to zip parsing and spine bootstrapping.
+
+## Native ink motion packaging check
+
+Run `pnpm --filter @papyrus-sdk/ui-react-native check:ink-worklets` before publishing. This builds and verifies all three ink chrome callbacks through the Reanimated Babel plugin in both CJS and ESM artifacts. Keep explicit `"worklet"` directives: bundler aliases such as `useAnimatedStyle2` are not automatically recognized by the plugin.

package/dist/index.d.mts

@@ -6,6 +6,8 @@ import { StyleProp, ViewStyle } from 'react-native';
 
 interface ViewerProps {
     engine: DocumentEngine;
+    /** Stable file identity, never the native engine/session ID. */
+    documentId?: string;
     /** Maximum page width at fit zoom, in React Native points; pinch zoom may enlarge it. */
     maxPageWidth?: number;
     /**
@@ -30,6 +32,20 @@ interface ViewerProps {
         text: string;
         pageIndex: number;
     }) => void;
+    /** Controls which native PDF selections can be sent to the dictionary. */
+    defineSelectionMode?: "selection" | "single-word";
+    /** Called when the native TXT view selects a UTF-16 range. */
+    onTextRangeSelected?: (payload: {
+        text: string;
+        start: number;
+        end: number;
+    }) => void;
+    /** Called when Define is chosen for a native TXT range. */
+    onDefineTextSelection?: (payload: {
+        text: string;
+        start: number;
+        end: number;
+    }) => void;
 }
 declare const Viewer: React.FC<ViewerProps>;
 
@@ -63,6 +79,7 @@ declare function useMobilePerf(): PerfSession;
 type PageViewComponentType = React.ComponentType<PapyrusPageViewProps & React.RefAttributes<any>>;
 interface PageRendererProps {
     engine: DocumentEngine;
+    documentId?: string;
     pageIndex: number;
     scale?: number;
     pageAspectRatio?: number;
@@ -107,12 +124,17 @@ interface RightSheetProps {
 }
 declare const RightSheet: React.FC<RightSheetProps>;
 
-declare const AnnotationEditor: React.FC;
+declare const AnnotationEditor: React.FC<{
+    documentId?: string;
+}>;
 
 type BottomBarProps = {
     documentType: DocumentType;
     onOpenInfo: () => void;
     onOpenSettings: () => void;
+    onTurnPage?: (direction: -1 | 1) => void;
+    onNavigateToPage?: (page: number) => void;
+    onOpenPages?: () => void;
     onOpenDestination?: (destination: MobilePrimaryDestination) => void;
 };
 declare const BottomBar: React.FC<BottomBarProps>;
@@ -121,6 +143,8 @@ interface SettingsSheetProps {
     engine: DocumentEngine;
     visible: boolean;
     onClose: () => void;
+    documentType?: DocumentType;
+    onOpenInfo?: () => void;
 }
 declare const SettingsSheet: React.FC<SettingsSheetProps>;
 
@@ -153,6 +177,7 @@ declare function ReadingShell({ engine, title, documentType, thumbsInitialCount,
 
 type NativePdfDocumentViewerProps = {
     engine: DocumentEngine;
+    documentId?: string;
     maxPageWidth?: number;
     onTextSelected?: (payload: {
         text: string;
@@ -162,8 +187,9 @@ type NativePdfDocumentViewerProps = {
         text: string;
         pageIndex: number;
     }) => void;
+    defineSelectionMode?: "selection" | "single-word";
 };
-declare function NativePdfDocumentViewer({ engine, maxPageWidth, onTextSelected, onDefineSelection, }: NativePdfDocumentViewerProps): react_jsx_runtime.JSX.Element;
+declare function NativePdfDocumentViewer({ engine, documentId, maxPageWidth, onTextSelected, onDefineSelection, defineSelectionMode, }: NativePdfDocumentViewerProps): react_jsx_runtime.JSX.Element;
 
 type OverflowSheetProps = {
     visible: boolean;
@@ -188,12 +214,14 @@ declare function DocumentActionsSheet({ visible, onClose, }: DocumentActionsShee
 
 type ProgressPillProps = {
     documentType: DocumentType;
+    navigationInDock?: boolean;
     onPress: () => void;
     onOpenPageJump?: () => void;
     onNavigateToPage?: (page: number) => void;
+    onTurnPage?: (direction: -1 | 1) => void;
     onScrubbingChange?: (active: boolean) => void;
 };
-declare function ProgressPill({ documentType, onPress, onOpenPageJump, onNavigateToPage, onScrubbingChange, }: ProgressPillProps): react_jsx_runtime.JSX.Element;
+declare function ProgressPill({ documentType, navigationInDock, onPress, onOpenPageJump, onNavigateToPage, onTurnPage, onScrubbingChange, }: ProgressPillProps): react_jsx_runtime.JSX.Element;
 
 type SearchOverlayProps = {
     engine: DocumentEngine;

package/dist/index.d.ts

@@ -6,6 +6,8 @@ import { StyleProp, ViewStyle } from 'react-native';
 
 interface ViewerProps {
     engine: DocumentEngine;
+    /** Stable file identity, never the native engine/session ID. */
+    documentId?: string;
     /** Maximum page width at fit zoom, in React Native points; pinch zoom may enlarge it. */
     maxPageWidth?: number;
     /**
@@ -30,6 +32,20 @@ interface ViewerProps {
         text: string;
         pageIndex: number;
     }) => void;
+    /** Controls which native PDF selections can be sent to the dictionary. */
+    defineSelectionMode?: "selection" | "single-word";
+    /** Called when the native TXT view selects a UTF-16 range. */
+    onTextRangeSelected?: (payload: {
+        text: string;
+        start: number;
+        end: number;
+    }) => void;
+    /** Called when Define is chosen for a native TXT range. */
+    onDefineTextSelection?: (payload: {
+        text: string;
+        start: number;
+        end: number;
+    }) => void;
 }
 declare const Viewer: React.FC<ViewerProps>;
 
@@ -63,6 +79,7 @@ declare function useMobilePerf(): PerfSession;
 type PageViewComponentType = React.ComponentType<PapyrusPageViewProps & React.RefAttributes<any>>;
 interface PageRendererProps {
     engine: DocumentEngine;
+    documentId?: string;
     pageIndex: number;
     scale?: number;
     pageAspectRatio?: number;
@@ -107,12 +124,17 @@ interface RightSheetProps {
 }
 declare const RightSheet: React.FC<RightSheetProps>;
 
-declare const AnnotationEditor: React.FC;
+declare const AnnotationEditor: React.FC<{
+    documentId?: string;
+}>;
 
 type BottomBarProps = {
     documentType: DocumentType;
     onOpenInfo: () => void;
     onOpenSettings: () => void;
+    onTurnPage?: (direction: -1 | 1) => void;
+    onNavigateToPage?: (page: number) => void;
+    onOpenPages?: () => void;
     onOpenDestination?: (destination: MobilePrimaryDestination) => void;
 };
 declare const BottomBar: React.FC<BottomBarProps>;
@@ -121,6 +143,8 @@ interface SettingsSheetProps {
     engine: DocumentEngine;
     visible: boolean;
     onClose: () => void;
+    documentType?: DocumentType;
+    onOpenInfo?: () => void;
 }
 declare const SettingsSheet: React.FC<SettingsSheetProps>;
 
@@ -153,6 +177,7 @@ declare function ReadingShell({ engine, title, documentType, thumbsInitialCount,
 
 type NativePdfDocumentViewerProps = {
     engine: DocumentEngine;
+    documentId?: string;
     maxPageWidth?: number;
     onTextSelected?: (payload: {
         text: string;
@@ -162,8 +187,9 @@ type NativePdfDocumentViewerProps = {
         text: string;
         pageIndex: number;
     }) => void;
+    defineSelectionMode?: "selection" | "single-word";
 };
-declare function NativePdfDocumentViewer({ engine, maxPageWidth, onTextSelected, onDefineSelection, }: NativePdfDocumentViewerProps): react_jsx_runtime.JSX.Element;
+declare function NativePdfDocumentViewer({ engine, documentId, maxPageWidth, onTextSelected, onDefineSelection, defineSelectionMode, }: NativePdfDocumentViewerProps): react_jsx_runtime.JSX.Element;
 
 type OverflowSheetProps = {
     visible: boolean;
@@ -188,12 +214,14 @@ declare function DocumentActionsSheet({ visible, onClose, }: DocumentActionsShee
 
 type ProgressPillProps = {
     documentType: DocumentType;
+    navigationInDock?: boolean;
     onPress: () => void;
     onOpenPageJump?: () => void;
     onNavigateToPage?: (page: number) => void;
+    onTurnPage?: (direction: -1 | 1) => void;
     onScrubbingChange?: (active: boolean) => void;
 };
-declare function ProgressPill({ documentType, onPress, onOpenPageJump, onNavigateToPage, onScrubbingChange, }: ProgressPillProps): react_jsx_runtime.JSX.Element;
+declare function ProgressPill({ documentType, navigationInDock, onPress, onOpenPageJump, onNavigateToPage, onTurnPage, onScrubbingChange, }: ProgressPillProps): react_jsx_runtime.JSX.Element;
 
 type SearchOverlayProps = {
     engine: DocumentEngine;