@datalking/begonia-react 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/LICENSE.md +661 -0
  2. package/README.md +34 -2
  3. package/dist/binding/BegoniaPdfViewer.d.ts +13 -0
  4. package/dist/binding/BrowserPaginatedPreview.d.ts +6 -0
  5. package/dist/binding/BrowserPaginatedPreviewUi.d.ts +13 -0
  6. package/dist/binding/BrowserWhiteboardPdfPreview.d.ts +8 -0
  7. package/dist/binding/BrowserWhiteboardPreview.d.ts +24 -0
  8. package/dist/binding/DocumentReactMount.d.ts +12 -0
  9. package/dist/binding/DrawingSceneSvg.d.ts +11 -0
  10. package/dist/binding/PaginatedLayoutView.d.ts +15 -0
  11. package/dist/binding/VirtualPagedPreview.d.ts +33 -0
  12. package/dist/binding/browser-whiteboard-page-overlay.d.ts +7 -0
  13. package/dist/binding/headless.d.ts +18 -0
  14. package/dist/binding/index.d.ts +12 -0
  15. package/dist/binding/paginated-layout-flow-mode.d.ts +1 -0
  16. package/dist/binding/paginated-layout-preview-options.d.ts +2 -0
  17. package/dist/binding/paginated-preview-defaults.d.ts +2 -0
  18. package/dist/binding/surface-feature-list.d.ts +4 -0
  19. package/dist/binding/use-browser-editor-controller.d.ts +16 -0
  20. package/dist/binding/use-browser-editor-document.d.ts +2 -0
  21. package/dist/binding/use-browser-editor-ui.d.ts +15 -0
  22. package/dist/binding/use-controller-snapshot.d.ts +6 -0
  23. package/dist/binding/use-editor-ui-controller.d.ts +5 -0
  24. package/dist/binding/use-owned-destroyable.d.ts +5 -0
  25. package/dist/binding/useVirtualPagedPreviewState.d.ts +28 -0
  26. package/dist/binding/v1.d.ts +12 -0
  27. package/dist/binding/virtual-paged-preview-anchor-hints.d.ts +2 -0
  28. package/dist/binding/virtual-paged-preview-drag-session.d.ts +2 -0
  29. package/dist/binding/virtual-paged-preview-drag.d.ts +2 -0
  30. package/dist/binding/virtual-paged-preview-inline-content.d.ts +3 -0
  31. package/dist/binding/virtual-paged-preview-interaction.d.ts +2 -0
  32. package/dist/binding/virtual-paged-preview-render-state.d.ts +2 -0
  33. package/dist/binding/virtual-paged-preview-renderers/virtual-paged-preview-block-text.d.ts +32 -0
  34. package/dist/binding/virtual-paged-preview-renderers/virtual-paged-preview-block-views.d.ts +17 -0
  35. package/dist/binding/virtual-paged-preview-renderers.d.ts +1 -0
  36. package/dist/binding/virtual-paged-preview-scroll-host.d.ts +2 -0
  37. package/dist/binding/virtual-paged-preview-session-state.d.ts +2 -0
  38. package/dist/binding/virtual-paged-preview-spacers.d.ts +2 -0
  39. package/dist/binding/virtual-paged-preview-table-metrics.d.ts +1 -0
  40. package/dist/binding/virtual-paged-preview-text-lines.d.ts +15 -0
  41. package/dist/binding/virtual-paged-preview-text-scale.d.ts +10 -0
  42. package/dist/binding/virtual-paged-preview-viewport-geometry.d.ts +2 -0
  43. package/dist/binding/virtual-paged-preview-viewport-state.d.ts +2 -0
  44. package/dist/binding/virtual-paged-preview-window-drag-listeners.d.ts +2 -0
  45. package/dist/chunk-IEHE33P5.js +1 -0
  46. package/dist/index.d.ts +26 -0
  47. package/dist/index.js +1 -0
  48. package/dist/v1.d.ts +10 -0
  49. package/dist/v1.js +1 -0
  50. package/package.json +54 -4
package/README.md CHANGED
@@ -1,3 +1,35 @@
1
- # Temporary Holding Version
1
+ # @datalking/begonia-react
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ React-facing browser surfaces for begonia.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install @datalking/begonia-react
9
+ ```
10
+
11
+ ## Stable root
12
+
13
+ - `BegoniaBrowserEditor` with an explicit `backend` adapter
14
+ - `EditorToolbar`
15
+ - `CommentsSidebar`
16
+ - `ReviewPanel`
17
+ - `ReviewTimelinePanel`
18
+ - `PaginatedLayoutView`
19
+ - `VirtualPagedPreview`
20
+ - `useEditorUiController`
21
+ - `BegoniaPdfViewer`
22
+
23
+ Use the package root when the app consumes the stable browser editor contract and wants thin React wrappers over headless UI/session state. When you mount `BegoniaBrowserEditor` from the root entrypoint, provide an explicit backend adapter such as the current ProseMirror-backed adapter from `@datalking/begonia-browser-sdk/v1`.
24
+ Pass the backend-specific mount payload through the stable `backendInput` prop so the root wrapper stays backend-agnostic.
25
+
26
+ ## `v1` runtime entrypoint
27
+
28
+ - `BegoniaBrowserEditor`
29
+ - `BrowserPaginatedPreview`
30
+ - `useBrowserEditorController`
31
+ - `useBrowserEditorDocument`
32
+ - `BrowserWhiteboardPreview`
33
+ - `BrowserWhiteboardPdfPreview`
34
+
35
+ Use `@datalking/begonia-react/v1` when the app needs the mounted ProseMirror-backed browser runtime or other controller-coupled conveniences.
@@ -0,0 +1,13 @@
1
+ import type { CSSProperties, ReactNode } from 'react';
2
+ import type { PdfViewerController, PdfViewerPageFrame } from '@datalking/begonia-pdf-viewer';
3
+ export interface BegoniaPdfViewerProps {
4
+ controller: PdfViewerController;
5
+ height?: number | string;
6
+ scale?: number;
7
+ pageGap?: number;
8
+ className?: string;
9
+ style?: CSSProperties;
10
+ emptyLabel?: string;
11
+ renderPageOverlay?: (frame: PdfViewerPageFrame) => ReactNode;
12
+ }
13
+ export declare function BegoniaPdfViewer({ controller, height, scale, pageGap, className, style, emptyLabel, renderPageOverlay, }: BegoniaPdfViewerProps): import("react").JSX.Element;
@@ -0,0 +1,6 @@
1
+ import { type BrowserEditorController } from '@datalking/begonia-browser/v1';
2
+ import { type BrowserPaginatedPreviewProps as BrowserPaginatedPreviewUiProps } from './BrowserPaginatedPreviewUi.tsx';
3
+ export interface BrowserPaginatedPreviewProps<TSource = unknown> extends Omit<BrowserPaginatedPreviewUiProps<TSource>, 'editor'> {
4
+ editor: BrowserEditorController | null;
5
+ }
6
+ export declare function BrowserPaginatedPreview<TSource = unknown>({ editor, ...props }: BrowserPaginatedPreviewProps<TSource>): import("react").JSX.Element;
@@ -0,0 +1,13 @@
1
+ import { type BrowserPreviewControllerNavigationMode } from '@datalking/begonia-browser-sdk/preview';
2
+ import { type BrowserViewportState } from '@datalking/begonia-browser-sdk';
3
+ import type { BrowserEditorUi, BrowserEditorUiHost } from '@datalking/begonia-browser-sdk';
4
+ import { type PaginatedLayoutViewProps } from './PaginatedLayoutView.tsx';
5
+ export interface BrowserPaginatedPreviewProps<TSource = unknown> extends Omit<PaginatedLayoutViewProps<TSource>, 'scale' | 'anchorPageNumber' | 'onViewportChange' | 'viewportRequestKey'> {
6
+ editor: BrowserEditorUi | BrowserEditorUiHost | null;
7
+ scale?: number;
8
+ anchorPageNumber?: number | null;
9
+ controllerNavigationMode?: BrowserPreviewControllerNavigationMode;
10
+ syncViewportToEditor?: boolean;
11
+ onViewportChange?: (state: BrowserViewportState) => void;
12
+ }
13
+ export declare function BrowserPaginatedPreview<TSource = unknown>({ editor, scale, flowMode, anchorPageNumber, controllerNavigationMode, syncViewportToEditor, onViewportChange, onLayoutChange, onProjectionPositionHit, ...props }: BrowserPaginatedPreviewProps<TSource>): import("react").JSX.Element;
@@ -0,0 +1,8 @@
1
+ import type { BrowserWhiteboardController } from '@datalking/begonia-browser';
2
+ import type { PdfViewerController } from '@datalking/begonia-pdf-viewer';
3
+ import { type BegoniaPdfViewerProps } from './BegoniaPdfViewer.tsx';
4
+ export interface BrowserWhiteboardPdfPreviewProps extends Omit<BegoniaPdfViewerProps, 'controller' | 'renderPageOverlay'> {
5
+ viewer: PdfViewerController;
6
+ controller: BrowserWhiteboardController;
7
+ }
8
+ export declare function BrowserWhiteboardPdfPreview({ viewer, controller, ...props }: BrowserWhiteboardPdfPreviewProps): import("react").JSX.Element;
@@ -0,0 +1,24 @@
1
+ import type { CSSProperties } from 'react';
2
+ import type { BrowserWhiteboardController } from '@datalking/begonia-browser';
3
+ import type { LayoutProjection } from '@datalking/begonia-layout-contracts';
4
+ import type { BrowserPaginatedPreviewProps } from './BrowserPaginatedPreview.tsx';
5
+ export interface BrowserWhiteboardPreviewProps {
6
+ projection: LayoutProjection | null;
7
+ controller: BrowserWhiteboardController;
8
+ height?: number;
9
+ scrollHost?: HTMLElement | null;
10
+ scale?: number;
11
+ pageGap?: number;
12
+ windowPages?: number;
13
+ overscan?: number;
14
+ virtualize?: boolean;
15
+ layoutMode?: BrowserPaginatedPreviewProps['layoutMode'];
16
+ flowMode?: BrowserPaginatedPreviewProps['flowMode'];
17
+ anchorPageNumber?: number | null;
18
+ pinnedPageNumbers?: readonly number[];
19
+ emptyLabel?: string;
20
+ onViewportChange?: BrowserPaginatedPreviewProps['onViewportChange'];
21
+ className?: string;
22
+ style?: CSSProperties;
23
+ }
24
+ export declare function BrowserWhiteboardPreview({ projection, controller, height, scrollHost, scale, pageGap, windowPages, overscan, virtualize, layoutMode, flowMode, anchorPageNumber, pinnedPageNumbers, emptyLabel, onViewportChange, className, style, }: BrowserWhiteboardPreviewProps): import("react").JSX.Element;
@@ -0,0 +1,12 @@
1
+ import { type DocumentSurface, type DocumentSurfaceOptions, type LocalRoom, type SurfaceFeatureDefinition } from '@datalking/begonia-engine';
2
+ export interface DocumentReactMountProps {
3
+ room?: LocalRoom;
4
+ collaborative?: DocumentSurfaceOptions['collaborative'];
5
+ participant: DocumentSurfaceOptions['participant'];
6
+ schema?: DocumentSurfaceOptions['schema'];
7
+ trackingEnabled?: boolean;
8
+ editable?: boolean;
9
+ features?: readonly SurfaceFeatureDefinition[];
10
+ onSurfaceReady?: (surface: DocumentSurface | null) => void;
11
+ }
12
+ export declare function DocumentReactMount({ room, collaborative, participant, schema, trackingEnabled, editable, features, onSurfaceReady, }: DocumentReactMountProps): import("react").JSX.Element;
@@ -0,0 +1,11 @@
1
+ import type { CSSProperties } from 'react';
2
+ import type { LayoutDrawingPayload } from '@datalking/begonia-layout-contracts';
3
+ export interface DrawingSceneSvgProps {
4
+ drawing: Pick<LayoutDrawingPayload, 'scene' | 'viewBox' | 'defs' | 'label' | 'width' | 'height'>;
5
+ width?: number | null;
6
+ height?: number | null;
7
+ className?: string;
8
+ style?: CSSProperties;
9
+ label?: string | null;
10
+ }
11
+ export declare function DrawingSceneSvg({ drawing, width, height, className, style, label, }: DrawingSceneSvgProps): import("react").JSX.Element;
@@ -0,0 +1,15 @@
1
+ import type { EditorLayoutAdapter, LayoutProjection, LayoutResolutionOptions, ResolvedLayoutProjection } from '@datalking/begonia-layout-contracts';
2
+ import { type VirtualPagedPreviewProps } from './VirtualPagedPreview.tsx';
3
+ import type { VirtualPagedPreviewPositionHitEvent } from './virtual-paged-preview-interaction.ts';
4
+ type PreviewProps = Pick<VirtualPagedPreviewProps, 'version' | 'measureText' | 'scrollHost' | 'height' | 'width' | 'scale' | 'pageGap' | 'windowPages' | 'overscan' | 'virtualize' | 'layoutMode' | 'flowMode' | 'anchorPageNumber' | 'initialViewportAnchor' | 'viewportRequestKey' | 'pinnedPageNumbers' | 'emptyLabel' | 'onViewportChange'>;
5
+ export type PaginatedLayoutViewProps<TSource = unknown> = PreviewProps & {
6
+ projection?: LayoutProjection | null;
7
+ adapter?: EditorLayoutAdapter<TSource>;
8
+ source?: TSource | null;
9
+ version?: number | string;
10
+ options?: LayoutResolutionOptions;
11
+ onLayoutChange?: (layout: ResolvedLayoutProjection | null) => void;
12
+ onProjectionPositionHit?: (event: VirtualPagedPreviewPositionHitEvent) => boolean | void;
13
+ };
14
+ export declare function PaginatedLayoutView<TSource = unknown>({ projection, adapter, source, version, options, measureText, onLayoutChange, scrollHost, height, width, scale, pageGap, windowPages, overscan, virtualize, layoutMode, flowMode, anchorPageNumber, initialViewportAnchor, viewportRequestKey, pinnedPageNumbers, emptyLabel, onViewportChange, onProjectionPositionHit, }: PaginatedLayoutViewProps<TSource>): import("react").JSX.Element;
15
+ export {};
@@ -0,0 +1,33 @@
1
+ import type { ReactNode } from 'react';
2
+ import type { LayoutProjection, LayoutProjectionOptions } from '@datalking/begonia-layout-contracts';
3
+ import type { LayoutFlowMode, LayoutRenderMode, PageViewportAnchor, PageViewportMetrics, VirtualPageFrame } from '@datalking/begonia-layout-renderer';
4
+ import type { VirtualPagedPreviewPositionHitEvent } from './virtual-paged-preview-interaction.ts';
5
+ export interface VirtualPagedPreviewProps {
6
+ projection: LayoutProjection | null;
7
+ version?: number | string | null;
8
+ measureText?: LayoutProjectionOptions['measureText'];
9
+ measurementEpoch?: LayoutProjectionOptions['measurementEpoch'];
10
+ height?: number;
11
+ width?: number;
12
+ /**
13
+ * Explicit viewport authority. Ancestor hosts use DOM-relative clipping;
14
+ * detached hosts drive virtualization directly from their scroll offsets.
15
+ */
16
+ scrollHost?: HTMLElement | null;
17
+ scale?: number;
18
+ pageGap?: number;
19
+ windowPages?: number;
20
+ overscan?: number;
21
+ virtualize?: boolean;
22
+ layoutMode?: LayoutRenderMode;
23
+ flowMode?: LayoutFlowMode;
24
+ anchorPageNumber?: number | null;
25
+ initialViewportAnchor?: PageViewportAnchor | null;
26
+ viewportRequestKey?: string | number | null;
27
+ pinnedPageNumbers?: readonly number[];
28
+ emptyLabel?: string;
29
+ onViewportChange?: (state: PageViewportMetrics) => void;
30
+ renderPageOverlay?: (frame: VirtualPageFrame, scale: number) => ReactNode;
31
+ onProjectionPositionHit?: (event: VirtualPagedPreviewPositionHitEvent) => boolean | void;
32
+ }
33
+ export declare function VirtualPagedPreview({ projection, version, measureText, measurementEpoch, height, width, scrollHost, scale, pageGap, windowPages, overscan, virtualize, layoutMode, flowMode, anchorPageNumber, initialViewportAnchor, viewportRequestKey, pinnedPageNumbers, emptyLabel, onViewportChange, renderPageOverlay, onProjectionPositionHit, }: VirtualPagedPreviewProps): import("react").JSX.Element;
@@ -0,0 +1,7 @@
1
+ import type { BrowserWhiteboardController, BrowserWhiteboardSnapshot } from '@datalking/begonia-browser';
2
+ export interface BrowserWhiteboardPageOverlayProps {
3
+ pageNumber: number;
4
+ controller: BrowserWhiteboardController;
5
+ snapshot: BrowserWhiteboardSnapshot;
6
+ }
7
+ export declare function BrowserWhiteboardPageOverlay({ pageNumber, controller, snapshot, }: BrowserWhiteboardPageOverlayProps): import("react").JSX.Element;
@@ -0,0 +1,18 @@
1
+ export { resolveVirtualPagedPreviewPositionHit, resolveVirtualPagedPreviewPositionHitInMountedFrames, } from './virtual-paged-preview-interaction.ts';
2
+ export type { ResolveVirtualPagedPreviewMountedFrameHitInput, ResolveVirtualPagedPreviewPositionHitInput, VirtualPagedPreviewSelectionAnchor, VirtualPagedPreviewPositionHitEvent, } from './virtual-paged-preview-interaction.ts';
3
+ export { applyVirtualPagedPreviewAutoscroll, createVirtualPagedPreviewAutoscrollController, resolveVirtualPagedPreviewAutoscrollDelta, } from './virtual-paged-preview-drag.ts';
4
+ export type { ApplyVirtualPagedPreviewAutoscrollInput, CreateVirtualPagedPreviewAutoscrollControllerInput, ResolveVirtualPagedPreviewAutoscrollDeltaInput, VirtualPagedPreviewAnimationScheduler, VirtualPagedPreviewAutoscrollController, VirtualPagedPreviewAutoscrollPointer, VirtualPagedPreviewScrollHost, } from './virtual-paged-preview-drag.ts';
5
+ export { createVirtualPagedPreviewDragSession, isVirtualPagedPreviewFrameTarget, VIRTUAL_PAGED_PREVIEW_FRAME_DATA_ATTRIBUTE, } from './virtual-paged-preview-drag-session.ts';
6
+ export type { CreateVirtualPagedPreviewDragSessionInput, VirtualPagedPreviewDragSession, VirtualPagedPreviewDragSessionResult, VirtualPagedPreviewMouseLikeEvent, } from './virtual-paged-preview-drag-session.ts';
7
+ export { bindVirtualPagedPreviewWindowDragListeners } from './virtual-paged-preview-window-drag-listeners.ts';
8
+ export type { BindVirtualPagedPreviewWindowDragListenersInput, VirtualPagedPreviewWindowDragBinding, VirtualPagedPreviewWindowDragStopInput, VirtualPagedPreviewWindowDragStopReason, VirtualPagedPreviewWindowLike, } from './virtual-paged-preview-window-drag-listeners.ts';
9
+ export { resolvePaginatedPreviewFlowMode, resolveRequestedPaginatedLayoutFlowMode, } from './paginated-layout-flow-mode.ts';
10
+ export { DEFAULT_VIRTUAL_PAGED_PREVIEW_SCALE, DEFAULT_WEB_FLOW_PAGE_HEIGHT_PX, WEB_VIRTUAL_PAGED_PREVIEW_HORIZONTAL_PADDING_PX, resolvePaginatedLayoutViewOptions, } from './paginated-layout-preview-options.ts';
11
+ export type { ResolvePaginatedLayoutViewOptionsInput } from './paginated-layout-preview-options.ts';
12
+ export { PREVIEW_TABLE_CELL_HORIZONTAL_PADDING, PREVIEW_TABLE_CELL_VERTICAL_PADDING, } from './virtual-paged-preview-table-metrics.ts';
13
+ export { resolveVirtualPagedPreviewRenderState } from './virtual-paged-preview-render-state.ts';
14
+ export type { VirtualPagedPreviewViewportResetReason, VirtualPagedPreviewRenderResolution, } from './virtual-paged-preview-render-state.ts';
15
+ export { cloneVirtualPagedPreviewMetrics, normalizeVirtualPagedPreviewPinnedPageIndexes, normalizeVirtualPagedPreviewRequestKey, resolveVirtualPagedPreviewHostMeasurement, resolveVirtualPagedPreviewResizeObserver, sameVirtualPagedPreviewMetrics, } from './virtual-paged-preview-viewport-state.ts';
16
+ export type { VirtualPagedPreviewHostMeasurement, VirtualPagedPreviewRequestKey, } from './virtual-paged-preview-viewport-state.ts';
17
+ export { createVirtualPagedPreviewSessionState, resolveVirtualPagedPreviewSessionCommit, resolveVirtualPagedPreviewSessionViewportEmission, } from './virtual-paged-preview-session-state.ts';
18
+ export type { ResolveVirtualPagedPreviewSessionCommitInput, ResolveVirtualPagedPreviewSessionViewportEmissionInput, VirtualPagedPreviewSessionState, VirtualPagedPreviewSessionViewportEmission, } from './virtual-paged-preview-session-state.ts';
@@ -0,0 +1,12 @@
1
+ export { BegoniaPdfViewer } from './BegoniaPdfViewer.tsx';
2
+ export type { BegoniaPdfViewerProps } from './BegoniaPdfViewer.tsx';
3
+ export { PaginatedLayoutView } from './PaginatedLayoutView.tsx';
4
+ export type { PaginatedLayoutViewProps } from './PaginatedLayoutView.tsx';
5
+ export { VirtualPagedPreview } from './VirtualPagedPreview.tsx';
6
+ export type { VirtualPagedPreviewProps } from './VirtualPagedPreview.tsx';
7
+ export { useBrowserEditorUi } from './use-browser-editor-ui.ts';
8
+ export type { BrowserEditorHostRef, UseBrowserEditorUiOptions, UseBrowserEditorUiResult, } from './use-browser-editor-ui.ts';
9
+ export { useEditorUiController } from './use-editor-ui-controller.ts';
10
+ export { useControllerSnapshot, useControllerSnapshotSignal, } from './use-controller-snapshot.ts';
11
+ export type { SnapshotController } from './use-controller-snapshot.ts';
12
+ export * from './headless.ts';
@@ -0,0 +1 @@
1
+ export { resolvePaginatedPreviewFlowMode, resolveRequestedPaginatedLayoutFlowMode, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { DEFAULT_VIRTUAL_PAGED_PREVIEW_SCALE, DEFAULT_WEB_FLOW_PAGE_HEIGHT_PX, WEB_VIRTUAL_PAGED_PREVIEW_HORIZONTAL_PADDING_PX, resolvePaginatedLayoutViewOptions, resolveVirtualPagedPreviewVirtualization, } from '@datalking/begonia-layout-renderer';
2
+ export type { ResolvePaginatedLayoutViewOptionsInput, ResolveVirtualPagedPreviewVirtualizationInput, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export declare const DEFAULT_VIRTUAL_PAGED_PREVIEW_PAGE_GAP = 28;
2
+ export declare function resolveVirtualPagedPreviewPageGap(value: number | null | undefined): number;
@@ -0,0 +1,4 @@
1
+ import type { SurfaceFeatureDefinition } from '@datalking/begonia-engine';
2
+ export declare function normalizeSurfaceFeatures(features?: readonly SurfaceFeatureDefinition[]): readonly SurfaceFeatureDefinition[];
3
+ export declare function sameSurfaceFeatureList(left: readonly SurfaceFeatureDefinition[], right: readonly SurfaceFeatureDefinition[]): boolean;
4
+ export declare function useStableSurfaceFeatures(features?: readonly SurfaceFeatureDefinition[]): readonly SurfaceFeatureDefinition[];
@@ -0,0 +1,16 @@
1
+ import { type MutableRefObject } from 'react';
2
+ import type { LocalRoom } from '@datalking/begonia-engine';
3
+ import type { BrowserEditorController, BrowserEditorState, CreateBrowserEditorOptions } from '@datalking/begonia-browser/v1';
4
+ export interface UseBrowserEditorControllerOptions extends Omit<CreateBrowserEditorOptions, 'element'> {
5
+ room?: LocalRoom;
6
+ zoomPercent?: number;
7
+ onControllerChange?: (controller: BrowserEditorController | null) => void;
8
+ onStateChange?: (state: BrowserEditorState | null) => void;
9
+ }
10
+ export type BrowserEditorHostRef = MutableRefObject<HTMLDivElement | null> & ((node: HTMLDivElement | null) => void);
11
+ export interface UseBrowserEditorControllerResult {
12
+ hostRef: BrowserEditorHostRef;
13
+ controller: BrowserEditorController | null;
14
+ state: BrowserEditorState | null;
15
+ }
16
+ export declare function useBrowserEditorController({ zoomPercent, zoomMode, fitWidthOptions, onControllerChange, onStateChange, ...options }: UseBrowserEditorControllerOptions): UseBrowserEditorControllerResult;
@@ -0,0 +1,2 @@
1
+ import { type BrowserEditorController } from '@datalking/begonia-browser/v1';
2
+ export declare function useBrowserEditorDocument(editor: BrowserEditorController | null): any;
@@ -0,0 +1,15 @@
1
+ import { type MutableRefObject } from 'react';
2
+ import type { BrowserEditorMountInput, BrowserEditorSessionSnapshot, BrowserEditorUi, BrowserEditorUiHost } from '@datalking/begonia-browser-sdk';
3
+ export interface UseBrowserEditorUiOptions<TBackendInput = unknown> extends BrowserEditorMountInput<TBackendInput> {
4
+ onEditorChange?: (editor: BrowserEditorUi | null) => void;
5
+ onHostChange?: (host: BrowserEditorUiHost | null) => void;
6
+ onSnapshotChange?: (snapshot: BrowserEditorSessionSnapshot | null) => void;
7
+ }
8
+ export type BrowserEditorHostRef = MutableRefObject<HTMLDivElement | null> & ((node: HTMLDivElement | null) => void);
9
+ export interface UseBrowserEditorUiResult {
10
+ hostRef: BrowserEditorHostRef;
11
+ ui: BrowserEditorUi | null;
12
+ host: BrowserEditorUiHost | null;
13
+ snapshot: BrowserEditorSessionSnapshot | null;
14
+ }
15
+ export declare function useBrowserEditorUi<TBackendInput = unknown>({ onEditorChange, onHostChange, onSnapshotChange, ...options }: UseBrowserEditorUiOptions<TBackendInput>): UseBrowserEditorUiResult;
@@ -0,0 +1,6 @@
1
+ export interface SnapshotController<TSnapshot> {
2
+ getSnapshot(): TSnapshot;
3
+ subscribe(listener: (snapshot: TSnapshot) => void): () => void;
4
+ }
5
+ export declare function useControllerSnapshot<TSnapshot>(controller: SnapshotController<TSnapshot> | null): TSnapshot | null;
6
+ export declare function useControllerSnapshotSignal<TSnapshot, TSignal>(controller: SnapshotController<TSnapshot> | null, selectSignal: (snapshot: TSnapshot) => TSignal): TSignal | null;
@@ -0,0 +1,5 @@
1
+ import { type EditorCommandId, type EditorControllerHost, type EditorUiController } from '@datalking/begonia-editor-ui';
2
+ export declare function useEditorUiController<TDocument = unknown, TCommandId extends string = EditorCommandId, TSelectionInfo = unknown>(host: EditorControllerHost<TDocument, TCommandId, TSelectionInfo> | null, externalController?: EditorUiController<TDocument, TCommandId, TSelectionInfo> | null): {
3
+ controller: EditorUiController<TDocument, TCommandId, TSelectionInfo>;
4
+ snapshot: import("@datalking/begonia-editor-contracts").EditorSessionSnapshot<TCommandId, TSelectionInfo>;
5
+ };
@@ -0,0 +1,5 @@
1
+ import { type DependencyList } from 'react';
2
+ export interface OwnedDestroyable {
3
+ destroy(): void;
4
+ }
5
+ export declare function useOwnedDestroyable<TValue extends OwnedDestroyable | null>(factory: () => TValue, dependencies: DependencyList): TValue;
@@ -0,0 +1,28 @@
1
+ import type { LayoutProjection } from '@datalking/begonia-layout-contracts';
2
+ import { type LayoutFlowMode, type LayoutRenderMode, type PageViewportMetrics, type PageViewportAnchor, type VirtualPagedPreviewObservedScrollHost } from '@datalking/begonia-layout-renderer';
3
+ interface UseVirtualPagedPreviewStateInput {
4
+ projection: LayoutProjection | null;
5
+ version?: number | string | null;
6
+ height: number;
7
+ width?: number | null;
8
+ scale: number;
9
+ pageGap: number;
10
+ windowPages: number;
11
+ overscan: number;
12
+ virtualize: boolean;
13
+ layoutMode: LayoutRenderMode;
14
+ flowMode: LayoutFlowMode;
15
+ anchorPageNumber: number | null;
16
+ initialViewportAnchor: PageViewportAnchor | null;
17
+ viewportRequestKey: string | number | null;
18
+ pinnedPageNumbers: readonly number[] | undefined;
19
+ scrollHost?: HTMLElement | null | undefined;
20
+ onViewportChange?: ((state: PageViewportMetrics) => void) | undefined;
21
+ }
22
+ export declare function useVirtualPagedPreviewState({ projection, version, height, width, scale, pageGap, windowPages, overscan, virtualize, layoutMode, flowMode, anchorPageNumber, initialViewportAnchor, viewportRequestKey, pinnedPageNumbers, scrollHost, onViewportChange, }: UseVirtualPagedPreviewStateInput): {
23
+ hostRef: import("react").RefObject<HTMLDivElement | null>;
24
+ resolveObservedScrollHost(): VirtualPagedPreviewObservedScrollHost | null;
25
+ deferredProjection: LayoutProjection | null;
26
+ renderState: import("@datalking/begonia-layout-renderer").PageWindowRendererState;
27
+ };
28
+ export {};
@@ -0,0 +1,12 @@
1
+ export * from './index.ts';
2
+ export { DocumentReactMount } from './DocumentReactMount.tsx';
3
+ export type { DocumentReactMountProps } from './DocumentReactMount.tsx';
4
+ export { BrowserPaginatedPreview } from './BrowserPaginatedPreview.tsx';
5
+ export type { BrowserPaginatedPreviewProps } from './BrowserPaginatedPreview.tsx';
6
+ export { BrowserWhiteboardPdfPreview } from './BrowserWhiteboardPdfPreview.tsx';
7
+ export type { BrowserWhiteboardPdfPreviewProps } from './BrowserWhiteboardPdfPreview.tsx';
8
+ export { BrowserWhiteboardPreview } from './BrowserWhiteboardPreview.tsx';
9
+ export type { BrowserWhiteboardPreviewProps } from './BrowserWhiteboardPreview.tsx';
10
+ export { useBrowserEditorController } from './use-browser-editor-controller.ts';
11
+ export type { UseBrowserEditorControllerOptions, UseBrowserEditorControllerResult, } from './use-browser-editor-controller.ts';
12
+ export { useBrowserEditorDocument } from './use-browser-editor-document.ts';
@@ -0,0 +1,2 @@
1
+ export { hasLogicalViewportAnchorHint } from '@datalking/begonia-layout-renderer';
2
+ export type { VirtualPagedPreviewLogicalAnchorHintLike } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { createVirtualPagedPreviewDragSession, isVirtualPagedPreviewFrameTarget, VIRTUAL_PAGED_PREVIEW_FRAME_DATA_ATTRIBUTE, } from '@datalking/begonia-layout-renderer';
2
+ export type { CreateVirtualPagedPreviewDragSessionInput, VirtualPagedPreviewDragSession, VirtualPagedPreviewDragSessionResult, VirtualPagedPreviewMouseLikeEvent, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { applyVirtualPagedPreviewAutoscroll, createVirtualPagedPreviewAutoscrollController, resolveVirtualPagedPreviewAutoscrollDelta, } from '@datalking/begonia-layout-renderer';
2
+ export type { ApplyVirtualPagedPreviewAutoscrollInput, CreateVirtualPagedPreviewAutoscrollControllerInput, ResolveVirtualPagedPreviewAutoscrollDeltaInput, VirtualPagedPreviewAnimationScheduler, VirtualPagedPreviewAutoscrollController, VirtualPagedPreviewAutoscrollPointer, VirtualPagedPreviewScrollHost, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,3 @@
1
+ import type { ReactNode } from 'react';
2
+ import type { InlineRevisionSpan } from '@datalking/begonia-layout-contracts';
3
+ export declare function renderVirtualPagedPreviewInlineContent(span: InlineRevisionSpan | null | undefined, text: string, scale: number): ReactNode;
@@ -0,0 +1,2 @@
1
+ export { resolveVirtualPagedPreviewPositionHit, resolveVirtualPagedPreviewPositionHitInMountedFrames, } from '@datalking/begonia-layout-renderer';
2
+ export type { ResolveVirtualPagedPreviewMountedFrameHitInput, ResolveVirtualPagedPreviewPositionHitInput, VirtualPagedPreviewPaginatedHorizontalOrigin, VirtualPagedPreviewPositionHitEvent, VirtualPagedPreviewSelectionAnchor, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { resolveVirtualPagedPreviewRenderState } from '@datalking/begonia-layout-renderer';
2
+ export type { ResolveVirtualPagedPreviewRenderStateInput, VirtualPagedPreviewRenderResolution, VirtualPagedPreviewViewportResetReason, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,32 @@
1
+ import { type CSSProperties } from 'react';
2
+ import { type LayoutProjectionOptions, type RenderableTableCellPlacement, type PageBlockPlacement } from '@datalking/begonia-layout-contracts';
3
+ declare function blockFontSize(block: PageBlockPlacement): number;
4
+ declare function blockTextAlign(block: Pick<PageBlockPlacement, 'align'>): CSSProperties['textAlign'];
5
+ declare function blockDirection(block: Pick<PageBlockPlacement, 'direction'>): CSSProperties['direction'];
6
+ declare function renderBlockText(block: PageBlockPlacement, scale: number, measureText?: LayoutProjectionOptions['measureText'], measurementEpoch?: LayoutProjectionOptions['measurementEpoch']): string | number | bigint | true | import("react").JSX.Element[] | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | Iterable<import("react").ReactNode> | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | import("react").ReactPortal | null | undefined> | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | null;
7
+ declare function renderTableCellContent(block: PageBlockPlacement, cell: RenderableTableCellPlacement, keyPrefix: string, scale: number): string | import("react").JSX.Element[];
8
+ declare function tableColumnStyles(block: PageBlockPlacement): import("react").JSX.Element[] | null;
9
+ declare function resolvePreviewTopPx(top: number, contentTop: number, scale: number): number;
10
+ declare function resolvePreviewLeftPx(left: number, contentLeft: number, scale: number): number;
11
+ declare function baseBlockStyle(block: PageBlockPlacement, scale: number, contentTop?: number, contentLeft?: number): {
12
+ position: 'absolute';
13
+ top: number;
14
+ left: number;
15
+ width: number;
16
+ minHeight: number;
17
+ paddingBottom: number;
18
+ fontSize: number;
19
+ lineHeight: string;
20
+ fontFamily: "\"Times New Roman\", serif";
21
+ whiteSpace: 'pre-wrap';
22
+ wordBreak: 'break-word';
23
+ color: "#1f2937" | "#2f2417";
24
+ fontWeight: number;
25
+ textAlign: import("csstype").Property.TextAlign | undefined;
26
+ direction: import("csstype").Property.Direction | undefined;
27
+ pointerEvents: 'none';
28
+ overflow: 'hidden';
29
+ paddingLeft: number | undefined;
30
+ paddingRight: number | undefined;
31
+ };
32
+ export { blockFontSize, blockTextAlign, blockDirection, baseBlockStyle, renderBlockText, tableColumnStyles, renderTableCellContent, resolvePreviewTopPx, resolvePreviewLeftPx, };
@@ -0,0 +1,17 @@
1
+ import { type ReactNode } from 'react';
2
+ import { type LayoutProjectionOptions } from '@datalking/begonia-layout-contracts';
3
+ import { type LayoutFlowMode, type VirtualPageFrame } from '@datalking/begonia-layout-renderer';
4
+ import type { VirtualPagedPreviewPositionHitEvent } from '../virtual-paged-preview-interaction.ts';
5
+ interface VirtualPageFrameViewProps {
6
+ frame: VirtualPageFrame;
7
+ scale: number;
8
+ measureText?: LayoutProjectionOptions['measureText'];
9
+ measurementEpoch?: LayoutProjectionOptions['measurementEpoch'];
10
+ offsetTop?: number;
11
+ offsetLeft?: number;
12
+ flowMode?: LayoutFlowMode;
13
+ renderPageOverlay?: (frame: VirtualPageFrame, scale: number) => ReactNode;
14
+ onProjectionPositionHit?: (event: VirtualPagedPreviewPositionHitEvent) => boolean | void;
15
+ }
16
+ export declare function VirtualPageFrameView({ frame, scale, measureText, measurementEpoch, offsetTop, offsetLeft, flowMode, renderPageOverlay, onProjectionPositionHit, }: VirtualPageFrameViewProps): import("react").JSX.Element;
17
+ export {};
@@ -0,0 +1 @@
1
+ export { VirtualPageFrameView } from './virtual-paged-preview-renderers/virtual-paged-preview-block-views.tsx';
@@ -0,0 +1,2 @@
1
+ export { bindVirtualPagedPreviewScrollHost, createVirtualPagedPreviewObservedScrollHostController, isVirtualPagedPreviewObservedWindowHost, resolveVirtualPagedPreviewObservedScrollHost, resolveVirtualPagedPreviewScrollHostPosition, resolveVirtualPagedPreviewScrollViewportPosition, } from '@datalking/begonia-layout-renderer';
2
+ export type { BindVirtualPagedPreviewScrollHostInput, CreateVirtualPagedPreviewObservedScrollHostControllerInput, VirtualPagedPreviewObservedPreviewHost, VirtualPagedPreviewObservedScrollHost, VirtualPagedPreviewObservedScrollHostController, VirtualPagedPreviewScrollHostBinding, VirtualPagedPreviewScrollHostPosition, VirtualPagedPreviewScrollViewportPosition, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { createVirtualPagedPreviewSessionState, resolveVirtualPagedPreviewSessionCommit, resolveVirtualPagedPreviewSessionViewportEmission, } from '@datalking/begonia-layout-renderer';
2
+ export type { ResolveVirtualPagedPreviewSessionCommitInput, ResolveVirtualPagedPreviewSessionViewportEmissionInput, VirtualPagedPreviewRequestState, VirtualPagedPreviewSessionState, VirtualPagedPreviewSessionViewportEmission, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { resolveVirtualPagedPreviewSpacerLayout } from '@datalking/begonia-layout-renderer';
2
+ export type { VirtualPagedPreviewFrameCluster, VirtualPagedPreviewInteriorGap, VirtualPagedPreviewSpacerAxis, VirtualPagedPreviewSpacerLayout, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1 @@
1
+ export { PREVIEW_TABLE_CELL_HORIZONTAL_PADDING, PREVIEW_TABLE_CELL_VERTICAL_PADDING, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,15 @@
1
+ import type { CSSProperties, ReactNode } from 'react';
2
+ import { type LayoutProjectionOptions, type PageBlockPlacement } from '@datalking/begonia-layout-contracts';
3
+ interface RenderMeasuredTextLinesInput {
4
+ block: PageBlockPlacement;
5
+ scale: number;
6
+ measureText?: LayoutProjectionOptions['measureText'];
7
+ measurementEpoch?: LayoutProjectionOptions['measurementEpoch'];
8
+ inlineSpanStyle: (block: PageBlockPlacement, span: NonNullable<PageBlockPlacement['inlineSpans']>[number], scale: number) => CSSProperties;
9
+ interactiveInlineNodeSpanProps: (span: NonNullable<PageBlockPlacement['inlineSpans']>[number], fromOffset: number, toOffset: number, cell?: {
10
+ originRow: number | null | undefined;
11
+ originColumn: number | null | undefined;
12
+ } | null) => Record<string, string | undefined> | null;
13
+ }
14
+ export declare function renderMeasuredTextLines(input: RenderMeasuredTextLinesInput): ReactNode;
15
+ export {};
@@ -0,0 +1,10 @@
1
+ export interface VirtualPagedPreviewInlineTextMetrics {
2
+ fontSize?: number | null;
3
+ letterSpacing?: number | null;
4
+ }
5
+ export declare function normalizeVirtualPagedPreviewTextScale(scale: number): number;
6
+ export declare function scaleVirtualPagedPreviewTextValue(value: number, scale: number): number;
7
+ export declare function resolveVirtualPagedPreviewInlineTextMetrics(metrics: VirtualPagedPreviewInlineTextMetrics, scale: number): {
8
+ fontSize: string | undefined;
9
+ letterSpacing: string | undefined;
10
+ };
@@ -0,0 +1,2 @@
1
+ export { createVirtualPagedPreviewViewportGeometry, resolveVirtualPagedPreviewViewportGeometryUpdate, restoreVirtualPagedPreviewViewportGeometry, sameVirtualPagedPreviewViewportGeometry, sameVirtualPagedPreviewViewportGeometryValue, } from '@datalking/begonia-layout-renderer';
2
+ export type { RestoreVirtualPagedPreviewViewportGeometryInput, VirtualPagedPreviewViewportGeometry, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { cloneVirtualPagedPreviewAnchor, cloneVirtualPagedPreviewMetrics, cloneVirtualPagedPreviewSnapshot, normalizeVirtualPagedPreviewPinnedPageIndexes, normalizeVirtualPagedPreviewRequestKey, resolveVirtualPagedPreviewHostMeasurement, resolveVirtualPagedPreviewResizeObserver, sameVirtualPagedPreviewAnchor, sameVirtualPagedPreviewMetrics, sameVirtualPagedPreviewSnapshot, } from '@datalking/begonia-layout-renderer';
2
+ export type { VirtualPagedPreviewHostMeasurement, VirtualPagedPreviewRequestKey, } from '@datalking/begonia-layout-renderer';
@@ -0,0 +1,2 @@
1
+ export { bindVirtualPagedPreviewWindowDragListeners } from '@datalking/begonia-layout-renderer';
2
+ export type { BindVirtualPagedPreviewWindowDragListenersInput, VirtualPagedPreviewWindowDragBinding, VirtualPagedPreviewWindowDragStopInput, VirtualPagedPreviewWindowDragStopReason, VirtualPagedPreviewWindowLike, } from '@datalking/begonia-layout-renderer';