@embedpdf/react 3.0.0-next.3 → 3.0.0-next.5

package/dist/annotation-B6jwfTCh.d.cts

@@ -1,173 +0,0 @@
-import { t as AnnotationDTO } from "./AnnotationListSnapshot-W0RCsyDE-dWna4TTJ.cjs";
-import { o as PageContextValue } from "./runtime-CMxIuF2O.cjs";
-import { Behavior, FilePickerProvider, SelectionFlags, SelectionFlags as SelectionFlags$1, SelectionProps, SelectionProps as SelectionProps$1 } from "@embedpdf/plugin-annotation";
-import * as React from "react";
-import { AnnotationFlags, AnnotationProps, AnnotationProps as AnnotationProps$1, AnnotationPropsPatch, AnnotationPropsPatch as AnnotationPropsPatch$1, Border, CreationDraftAnchor, Geom, LineEnding, LineEndings, PropKey, PropSpec, Rect, RenderItem, RenderItem as RenderItem$1, Style, TextAlign, TextStyle, Vec } from "@embedpdf/core-annotation";
-import { Rect as Rect$1 } from "@embedpdf/core-geometry";
-//#region src/internal/annotation-menu-position.d.ts
-type AnnotationMenuPlacement = 'top' | 'right' | 'bottom' | 'left';
-//#endregion
-//#region src/annotation.d.ts
-/**
- * What an annotation renderer receives: the projected item (its `box` is LIVE —
- * it follows drags), the page context, the engine's baked /AP raster (the
- * "picture"), the default visual (`native` — wrap it or ignore it), and
- * whether this entry currently OWNS the pointer (`interactive`). While not
- * interactive the layer renders your component pointer-locked: the annotation
- * stays a first-class citizen of the annotation plane (select/move/resize).
- */
-interface AnnotationRendererProps {
-  item: RenderItem;
-  page: PageContextValue;
-  appearance: {
-    url: string;
-    box: Rect;
-  } | null;
-  native: React.ReactNode;
-  interactive: boolean;
-}
-/**
- * ONE rule: "for THESE annotations, render THIS component, and it owns the
- * pointer WHEN …". The two shapes:
- *
- *   - `{ for, component, interactive? }` — your own rule. Without
- *     `interactive` it is a pure SKIN: pixels only, mechanically
- *     pointer-locked, the annotation plane keeps selection/move/resize. With
- *     `interactive` (boolean or live predicate) the layer registers a plugin
- *     Behavior for you: while it holds, the annotation plane stands down
- *     (hit-test-inert) and your component owns the input.
- *   - `{ behavior, component }` — the renderer for a PLUGIN-registered
- *     behavior (the form plugin's fill controls via `formWidgetRenderer`);
- *     the plugin decides engagement, never the app.
- *
- * Resolution: ownership beats skin — an ENGAGED behavior's component is
- * authoritative; `for` rules apply only to plane-owned annotations, first
- * match wins. Define entries OUTSIDE render (module scope or useMemo): entry
- * identity keys the behavior registration.
- */
-type AnnotationRenderer = {
-  behavior: string;
-  component: React.ComponentType<AnnotationRendererProps>;
-} | {
-  /** Stable id for the auto-registered behavior (optional; generated). */
-  id?: string;
-  for: Behavior['matches'];
-  component: React.ComponentType<AnnotationRendererProps>;
-  interactive?: boolean | (() => boolean);
-};
-interface AnnotationLayerProps {
-  /** Annotation renderers — skins and interactive takeovers ({@link AnnotationRenderer}). */
-  renderers?: AnnotationRenderer[];
-}
-declare function AnnotationLayer({ renderers }?: AnnotationLayerProps): import("react/jsx-runtime").JSX.Element;
-/**
- * The default file-picker provider: the built-in file dialog (from
- * `@embedpdf/web`), honouring the tool's `accept` filter. This is the ADAPTER
- * fulfilling the plugin's DOM-free port — the dialog lives here, in the
- * framework layer, never in the plugin. A picked `File` carries its own name
- * and mime, so it goes straight through as the engine's file source.
- */
-declare const filePickerProvider: FilePickerProvider;
-/**
- * Install the file-picker provider for the active document — the ONE port
- * behind every click-then-pick tool (a stamp `'prompt'` source, the file-
- * attachment tool). Call ONCE at a document-scoped spot (not inside
- * `<AnnotationLayer>`, which is per page). Defaults to
- * {@link filePickerProvider}, so a bare `useFilePickerProvider()` makes all of
- * them work out of the box; pass a custom provider (asset library, cloud
- * drive — switch on `req.subtype` / `req.toolId`) or `null` to make
- * click-then-pick tools inert. Cleared on unmount.
- */
-declare function useFilePickerProvider(provider?: FilePickerProvider | null): void;
-declare function useAnnotation(): import("@embedpdf/plugin-annotation").AnnotationCapability;
-declare function useAnnotationSelection(): string[];
-/** The selected annotations as engine DTOs — for selection-aware toolbars/sidebars. */
-declare function useAnnotationSelected(): AnnotationDTO[];
-/**
- * A tool's RESOLVED defaults (base + per-tool override) as a full flat props
- * bag, subscribed so a `setDefaults` re-renders the consumer. Use this — not the
- * imperative `useAnnotation().currentDefaults(id)` — to drive default-editing
- * controls, so they reflect changes live. Pair with `propsForTool(id)` for the
- * specs to render.
- */
-declare function useAnnotationDefaults(toolId: string): AnnotationProps;
-/**
- * The selection's editable properties — ordered specs shared by every selected
- * kind, current values, and which keys are mixed. THE hook a property sidebar
- * renders from; write back with `useAnnotation().updateSelection({ [key]: v })`.
- * Reference-stable between model changes (the capability memoizes by model
- * identity), so the default equality is enough.
- */
-declare function useSelectionProps(): SelectionProps;
-/**
- * The selection's `/F` annotation flags — per-flag `true`/`false`, `null` where
- * the selected annotations disagree (render an indeterminate control), `null`
- * overall when nothing is selected. Write back with
- * `useAnnotation().updateSelectionFlags({ locked: true })`. Reference-stable
- * between model changes, like {@link useSelectionProps}.
- */
-declare function useSelectionFlags(): SelectionFlags | null;
-/** The selection's menu anchor: the primary page + the union box of the selection
- *  on that page (content space). */
-type SelectionAnchor = {
-  pon: number;
-  bounds: Rect;
-  knob?: Vec;
-};
-/** Structural equality for the selection anchor — keeps the menu from re-rendering
- *  on unrelated dispatches (the capability returns a fresh object each call). */
-declare function sameAnchor(a: SelectionAnchor | null, b: SelectionAnchor | null): boolean;
-/** What a menu's render prop receives: the live selection (engine DTOs) + the
- *  selection-scoped intents. Fully headless — you render all UI. */
-interface AnnotationMenuRenderArgs {
-  selected: ReturnType<typeof useAnnotationSelected>;
-  deleteSelection: () => void;
-  deselect: () => void;
-  /** Restyle the selection with a flat props patch (see `useSelectionProps`). */
-  updateSelection: (patch: AnnotationPropsPatch) => void;
-  /** Rotate the current selection a quarter-turn clockwise about its centre. */
-  rotate90: () => void;
-  /** Reset the current selection to its as-authored orientation. */
-  resetRotation: () => void;
-  /** Group the current selection into one unit (selecting any member then
-   *  selects all). */
-  group: () => Promise<void>;
-  /** Ungroup the group(s) the current selection touches. */
-  ungroup: () => Promise<void>;
-  /** Whether {@link group} would do something for the current selection. */
-  canGroup: boolean;
-  /** Whether {@link ungroup} would do something for the current selection. */
-  canUngroup: boolean;
-}
-interface AnnotationMenuProps {
-  children: (args: AnnotationMenuRenderArgs) => React.ReactNode;
-  /** Gap in screen px between the selection box and the menu (default 8). */
-  gap?: number;
-  /** Where to place the menu relative to the selection box. Default 'top'. */
-  placement?: AnnotationMenuPlacement;
-}
-declare function sameCreationDraftAnchor(a: CreationDraftAnchor | null, b: CreationDraftAnchor | null): boolean;
-interface AnnotationDraftMenuRenderArgs extends CreationDraftAnchor {
-  finish: () => void;
-  cancel: () => void;
-}
-interface AnnotationDraftMenuProps {
-  children: (args: AnnotationDraftMenuRenderArgs) => React.ReactNode;
-  /** Gap in screen px between the draft anchor and the menu (default 8). */
-  gap?: number;
-  /** Where to place the menu relative to the draft anchor. Default 'top'. */
-  placement?: AnnotationMenuPlacement;
-}
-/**
- * The Stage-FREE selection menu, for `<PageView>` (no camera). It transforms a
- * selected content rect to client px via `page.toClientRect`, then renders an
- * UPRIGHT menu through a portal to
- * `document.body` (so it never rotates with the page nor clips at a container
- * edge). Re-measures on scroll/resize. For `<Stage>`, prefer `<AnnotationMenu>`
- * from `@embedpdf/react/annotation-menu` (camera-driven, more responsive).
- */
-declare function PageAnnotationMenu({ children, gap, placement }: AnnotationMenuProps): React.ReactPortal | null;
-declare function PageAnnotationDraftMenu({ children, gap, placement }: AnnotationDraftMenuProps): React.ReactPortal | null;
-//#endregion
-export { useAnnotation as A, SelectionProps$1 as C, filePickerProvider as D, TextStyle as E, useSelectionFlags as F, useSelectionProps as I, AnnotationMenuPlacement as L, useAnnotationSelected as M, useAnnotationSelection as N, sameAnchor as O, useFilePickerProvider as P, SelectionFlags$1 as S, TextAlign as T, PageAnnotationMenu as _, AnnotationLayerProps as a, RenderItem$1 as b, AnnotationProps$1 as c, AnnotationRendererProps as d, Border as f, PageAnnotationDraftMenu as g, LineEndings as h, AnnotationLayer as i, useAnnotationDefaults as j, sameCreationDraftAnchor as k, AnnotationPropsPatch$1 as l, LineEnding as m, AnnotationDraftMenuRenderArgs as n, AnnotationMenuProps as o, Geom as p, AnnotationFlags as r, AnnotationMenuRenderArgs as s, AnnotationDraftMenuProps as t, AnnotationRenderer as u, PropKey as v, Style as w, SelectionAnchor as x, PropSpec as y };
-//# sourceMappingURL=annotation-B6jwfTCh.d.cts.map