@embedpdf/plugin-annotation 2.14.4 → 3.0.0-next.0

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { C as PromptSourceSpec, D as ToolAuthoringKind, E as StampSourceSpec, O as ToolDefaultsFor, S as InkAuthoringOptions, T as SelectionAuthoring, _ as ToolGhost, a as AnnotationState, b as DEFAULT_TOOLS, c as ChromeSettings, d as FilePromptRequest, f as LinkNavItem, g as TextItem, h as StampToolInput, i as AnnotationHostCapability, l as ChromeSettingsPatch, m as SelectionProps, n as AnnotationCapability, p as SelectionFlags, r as AnnotationConfig, s as Behavior, t as AnnotationAction, u as FilePickerProvider, v as AnnotationToolDef, w as ResolvedTool, x as GhostPolicy, y as AnnotationToolInput } from "./types-BhWgqgbX.cjs";
+import { CapabilityToken } from "@embedpdf/core";
+import { AnnotationDTO, AnnotationDraft, AnnotationPatch, AnnotationRef, PdfLinkTarget, PdfRect, WidgetAppearance } from "@embedpdf/engine-core/runtime";
+import { Annot, AnnotationFlags, AnnotationProps, AnnotationPropsPatch, AnnotationPropsPatch as AnnotationPropsPatch$1, BlendMode, Border, ClickCreate, ClickPlacement, Geom, LineEnding, LineEndings, MIN_DRAG, PropKey, PropKey as PropKey$1, PropSpec, Rect, SnapSettings, Style, TextAlign, propsFor, resolveClickPlacement } from "@embedpdf/core-annotation";
+//#region src/annotation.plugin.d.ts
+/**
+ * The annotation plugin. Document-scoped; requires the interaction hub and
+ * OPTIONALLY uses the selection plugin. Shapes/ink work with no selection; text
+ * markup lights up only when a selection plugin is present.
+ */
+declare const annotationPlugin: (config?: AnnotationConfig) => import("@embedpdf/core").PluginDef<AnnotationState, AnnotationAction, AnnotationHostCapability>;
+//#endregion
+//#region src/repository/seam.d.ts
+declare function refKey(ref: AnnotationRef): string;
+/** Engine DTO → content-space `Style` (CSS colours, `Border` union). Exported so
+ *  selection-aware UIs can read display values straight off a {@link AnnotationDTO}
+ *  without re-deriving the colour/border mapping. */
+declare function styleFromDTO(dto: AnnotationDTO): Style;
+/**
+ * The flat props vocabulary (CSS colours, house keys) → the engine's widget
+ * appearance for `doc.forms` authoring — the SAME mapping the widget patch
+ * lowering uses, exported as a boundary utility so the form plugin can style
+ * `placeField` from a tool's `currentDefaults` without growing a second CSS
+ * parser. Absent keys stay absent (the engine writes nothing for them).
+ */
+declare function widgetAppearanceFromProps(props: AnnotationPropsPatch$1): WidgetAppearance;
+//#endregion
+//#region src/repository/index.d.ts
+/**
+ * Engine DTO → content-space Annot. `source` decides how it renders: `'baked'`
+ * shows the engine's appearance raster (a page load, or a remote edit — trust
+ * the authored AP); `'vector'` renders live from geom/style (we authored or
+ * changed it). `apBox` is the raster's content-space box, used while baked.
+ */
+declare function fromDTO(dto: AnnotationDTO, crop: PdfRect, source?: 'baked' | 'vector'): Annot;
+/** Content Annot → the FULL engine patch: the kind's geometry group plus every
+ *  prop it declares editable. The reference statement — scoped emission and
+ *  drafts both build on it. */
+declare function toPatch(a: Annot, crop: PdfRect): AnnotationPatch | null;
+/** Content Annot → engine create draft: the full statement plus the kind's
+ *  create-only extras, with the model's `/F` emitted verbatim, once, for every
+ *  kind (a fresh draw carries DRAWN_FLAGS plus any tool seed). `null` for the
+ *  kinds whose creates travel their own path (stamps, widgets, icon place). */
+declare function toCreateDraft(a: Annot, crop: PdfRect): AnnotationDraft | null;
+//#endregion
+//#region src/reducer.d.ts
+/**
+ * Out-of-the-box selection chrome — a sensible document-annotation feel. Every
+ * length is CSS px (screen-constant across zoom); every color falls back to
+ * `accent`. Just defaults: override any field at registration
+ * (`annotationPlugin({ chrome })`) or at runtime (`setChrome`).
+ */
+declare const DEFAULT_CHROME: ChromeSettings;
+//#endregion
+//#region src/index.d.ts
+/**
+ * App-facing annotation token: resolves the public {@link AnnotationCapability}.
+ * It is the SAME runtime token the plugin provides, narrowed to the public lens —
+ * the framework-only surface (render projection, pointer gestures, behavior
+ * registration) is reachable only via `@embedpdf/plugin-annotation/internal`.
+ */
+declare const AnnotationToken: CapabilityToken<AnnotationCapability>;
+//#endregion
+export { type AnnotationAction, type AnnotationCapability, type AnnotationConfig, type AnnotationFlags, type AnnotationProps, type AnnotationPropsPatch, type AnnotationState, AnnotationToken, type AnnotationToolDef, type AnnotationToolInput, type Behavior, type BlendMode, type Border, type ChromeSettings, type ChromeSettingsPatch, type ClickCreate, type ClickPlacement, DEFAULT_CHROME, DEFAULT_TOOLS, type FilePickerProvider, type FilePromptRequest, type GhostPolicy, type InkAuthoringOptions, type LineEnding, type LineEndings, type LinkNavItem, MIN_DRAG, type PromptSourceSpec, type PropKey, type PropSpec, type ResolvedTool, type SelectionAuthoring, type SelectionFlags, type SelectionProps, type SnapSettings, type StampSourceSpec, type StampToolInput, type TextAlign, type TextItem, type ToolAuthoringKind, type ToolDefaultsFor, type ToolGhost, annotationPlugin, fromDTO, propsFor, refKey, resolveClickPlacement, styleFromDTO, toCreateDraft, toPatch, widgetAppearanceFromProps };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1 +1,65 @@
-export * from './lib';
+import { C as PromptSourceSpec, D as ToolAuthoringKind, E as StampSourceSpec, O as ToolDefaultsFor, S as InkAuthoringOptions, T as SelectionAuthoring, _ as ToolGhost, a as AnnotationState, b as DEFAULT_TOOLS, c as ChromeSettings, d as FilePromptRequest, f as LinkNavItem, g as TextItem, h as StampToolInput, i as AnnotationHostCapability, l as ChromeSettingsPatch, m as SelectionProps, n as AnnotationCapability, p as SelectionFlags, r as AnnotationConfig, s as Behavior, t as AnnotationAction, u as FilePickerProvider, v as AnnotationToolDef, w as ResolvedTool, x as GhostPolicy, y as AnnotationToolInput } from "./types-Da6JRmhw.js";
+import { CapabilityToken } from "@embedpdf/core";
+import { AnnotationDTO, AnnotationDraft, AnnotationPatch, AnnotationRef, PdfLinkTarget, PdfRect, WidgetAppearance } from "@embedpdf/engine-core/runtime";
+import { Annot, AnnotationFlags, AnnotationProps, AnnotationPropsPatch, AnnotationPropsPatch as AnnotationPropsPatch$1, BlendMode, Border, ClickCreate, ClickPlacement, Geom, LineEnding, LineEndings, MIN_DRAG, PropKey, PropKey as PropKey$1, PropSpec, Rect, SnapSettings, Style, TextAlign, propsFor, resolveClickPlacement } from "@embedpdf/core-annotation";
+//#region src/annotation.plugin.d.ts
+/**
+ * The annotation plugin. Document-scoped; requires the interaction hub and
+ * OPTIONALLY uses the selection plugin. Shapes/ink work with no selection; text
+ * markup lights up only when a selection plugin is present.
+ */
+declare const annotationPlugin: (config?: AnnotationConfig) => import("@embedpdf/core").PluginDef<AnnotationState, AnnotationAction, AnnotationHostCapability>;
+//#endregion
+//#region src/repository/seam.d.ts
+declare function refKey(ref: AnnotationRef): string;
+/** Engine DTO → content-space `Style` (CSS colours, `Border` union). Exported so
+ *  selection-aware UIs can read display values straight off a {@link AnnotationDTO}
+ *  without re-deriving the colour/border mapping. */
+declare function styleFromDTO(dto: AnnotationDTO): Style;
+/**
+ * The flat props vocabulary (CSS colours, house keys) → the engine's widget
+ * appearance for `doc.forms` authoring — the SAME mapping the widget patch
+ * lowering uses, exported as a boundary utility so the form plugin can style
+ * `placeField` from a tool's `currentDefaults` without growing a second CSS
+ * parser. Absent keys stay absent (the engine writes nothing for them).
+ */
+declare function widgetAppearanceFromProps(props: AnnotationPropsPatch$1): WidgetAppearance;
+//#endregion
+//#region src/repository/index.d.ts
+/**
+ * Engine DTO → content-space Annot. `source` decides how it renders: `'baked'`
+ * shows the engine's appearance raster (a page load, or a remote edit — trust
+ * the authored AP); `'vector'` renders live from geom/style (we authored or
+ * changed it). `apBox` is the raster's content-space box, used while baked.
+ */
+declare function fromDTO(dto: AnnotationDTO, crop: PdfRect, source?: 'baked' | 'vector'): Annot;
+/** Content Annot → the FULL engine patch: the kind's geometry group plus every
+ *  prop it declares editable. The reference statement — scoped emission and
+ *  drafts both build on it. */
+declare function toPatch(a: Annot, crop: PdfRect): AnnotationPatch | null;
+/** Content Annot → engine create draft: the full statement plus the kind's
+ *  create-only extras, with the model's `/F` emitted verbatim, once, for every
+ *  kind (a fresh draw carries DRAWN_FLAGS plus any tool seed). `null` for the
+ *  kinds whose creates travel their own path (stamps, widgets, icon place). */
+declare function toCreateDraft(a: Annot, crop: PdfRect): AnnotationDraft | null;
+//#endregion
+//#region src/reducer.d.ts
+/**
+ * Out-of-the-box selection chrome — a sensible document-annotation feel. Every
+ * length is CSS px (screen-constant across zoom); every color falls back to
+ * `accent`. Just defaults: override any field at registration
+ * (`annotationPlugin({ chrome })`) or at runtime (`setChrome`).
+ */
+declare const DEFAULT_CHROME: ChromeSettings;
+//#endregion
+//#region src/index.d.ts
+/**
+ * App-facing annotation token: resolves the public {@link AnnotationCapability}.
+ * It is the SAME runtime token the plugin provides, narrowed to the public lens —
+ * the framework-only surface (render projection, pointer gestures, behavior
+ * registration) is reachable only via `@embedpdf/plugin-annotation/internal`.
+ */
+declare const AnnotationToken: CapabilityToken<AnnotationCapability>;
+//#endregion
+export { type AnnotationAction, type AnnotationCapability, type AnnotationConfig, type AnnotationFlags, type AnnotationProps, type AnnotationPropsPatch, type AnnotationState, AnnotationToken, type AnnotationToolDef, type AnnotationToolInput, type Behavior, type BlendMode, type Border, type ChromeSettings, type ChromeSettingsPatch, type ClickCreate, type ClickPlacement, DEFAULT_CHROME, DEFAULT_TOOLS, type FilePickerProvider, type FilePromptRequest, type GhostPolicy, type InkAuthoringOptions, type LineEnding, type LineEndings, type LinkNavItem, MIN_DRAG, type PromptSourceSpec, type PropKey, type PropSpec, type ResolvedTool, type SelectionAuthoring, type SelectionFlags, type SelectionProps, type SnapSettings, type StampSourceSpec, type StampToolInput, type TextAlign, type TextItem, type ToolAuthoringKind, type ToolDefaultsFor, type ToolGhost, annotationPlugin, fromDTO, propsFor, refKey, resolveClickPlacement, styleFromDTO, toCreateDraft, toPatch, widgetAppearanceFromProps };
+//# sourceMappingURL=index.d.ts.map