@embedpdf/plugin-stage 3.0.0-next.13 → 3.0.0-next.15

package/dist/host-contract-CPtbnJ4j.d.cts

@@ -0,0 +1,95 @@
+import { A as StageCapability, I as StageSettings, U as ViewportPoint, z as StageViewState } from "./contract-DZR_jRer.cjs";
+import { PageRef, Unsubscribe } from "@embedpdf/core";
+import { Point as Point$1, Rect as Rect$1 } from "@embedpdf/core-geometry";
+import { Camera, Camera as Camera$1, ScrollMetrics, Size, Size as Size$1 } from "@embedpdf/core-stage";
+//#region src/model.d.ts
+interface StageState extends StageSettings {
+  readonly camera: Camera;
+  /**
+   * One-way render-commit latch. False while the initial viewport-driven
+   * placement is unresolved; true only after its camera and settings writes
+   * have completed. Page and scroll screen-space reads refuse to answer while
+   * false, so an adapter can never paint the placeholder camera at the origin.
+   */
+  readonly placed: boolean;
+  /**
+   * Names of the responsive rules currently matching the box, in source order.
+   * State (not derived) so `matchesRule()` is reactive in every framework.
+   */
+  readonly activeRules: readonly string[];
+  /**
+   * False while the zoom is in motion, true once it has rested (about 150 ms
+   * of frames without a zoom write). Device-snapping of page origins is gated
+   * on this: a continuous zoom and a snapped origin cannot coexist without the
+   * anchor point jittering ±0.5 device px per step, so pages place
+   * fractionally while zooming and snap once at rest. Pans always snap (a pure
+   * translation has no anchor error).
+   */
+  readonly cameraResting: boolean;
+  /** The container size the host reported, in viewport px. */
+  readonly viewport: Size;
+  /**
+   * Device pixels per view pixel (web: `window.devicePixelRatio`). Feeds each
+   * page's transform so bitmaps render crisp and boxes land on the device
+   * grid. Defaults to 1.
+   */
+  readonly dpr: number;
+  /**
+   * The current page index, valid in both flows. Navigation sets it; in
+   * continuous flow manipulation derives it from the camera; in paged flow
+   * panning never moves it (the scene is a one-item slice at this page).
+   * An index, so it survives spread and layout regrouping.
+   */
+  readonly cursor: number;
+  /**
+   * What last drove the camera or cursor: `'programmatic'` for the arrival
+   * and reveal verbs (the ones action executors use), `'user'` for direct
+   * manipulation (wheel, drag, scrollbars, embedder scroll calls). The
+   * page-state feed hands it to the actions plugin, whose cascade budget
+   * counts only programmatic rounds, so user scrolling is never throttled.
+   */
+  readonly motionCause: 'user' | 'programmatic';
+}
+//#endregion
+//#region src/host-contract.d.ts
+/**
+ * The host lens: what the surface binding, the gesture controller and sibling
+ * plugins need. The same runtime token as the public contract, typed wider.
+ */
+interface StageHostCapability extends StageCapability {
+  /**
+   * Report the container box (ResizeObserver); the first real size triggers placement. After
+   * that, a box with no area (hidden, or taken out of the page) keeps the last real viewport.
+   */
+  setViewportSize(size: Size$1): void;
+  /** Report the device pixel ratio so page transforms render crisp. */
+  setDevicePixelRatio(ratio: number): void;
+  /** Bracket a direct-manipulation gesture (touch pan / pinch); `elastic` enables rubber-band. */
+  beginGesture(options?: {
+    elastic?: boolean;
+  }): void;
+  endGesture(): void;
+  /** Momentum pan from a release velocity in viewport px/s. */
+  fling(velocityX: number, velocityY: number): void;
+  /** The touch double-tap zoom ladder around a viewport point. */
+  doubleTapZoom(point: ViewportPoint): void;
+  /** Zoom by a factor holding a viewport point fixed — the pinch primitive. */
+  zoomAround(point: ViewportPoint, factor: number): void;
+  /** The camera as a native scroller, in viewport px. Reference-stable. */
+  getScrollMetrics(): ScrollMetrics;
+  worldToViewport(world: Point$1): ViewportPoint;
+  viewportToWorld(point: ViewportPoint): Point$1;
+  pageToWorld(page: PageRef, point: Point$1): Point$1 | null;
+  /** Offer a candidate initial view; the highest-priority non-null wins at placement. */
+  provideInitialView(priority: number, provider: () => StageViewState | null): Unsubscribe;
+  /** Resolve the registered providers once (else reset). Called when the viewport is ready. */
+  placeInitial(): void;
+  /** Re-resolve the zoom intent against the current scene (wired to the page registry). */
+  refit(): void;
+  /** This lens's identity — the stage plugin id; pointer samples are stamped with it. */
+  getLensId(): string;
+}
+declare const StageToken: import("@embedpdf/core").CapabilityToken<StageHostCapability>;
+//#endregion
+export { Size$1 as a, StageState as c, ScrollMetrics as i, Point$1 as n, StageHostCapability as o, Rect$1 as r, StageToken as s, Camera$1 as t };
+//# sourceMappingURL=host-contract-CPtbnJ4j.d.cts.map

package/dist/host-contract-Du5tEZ4h.d.ts

@@ -0,0 +1,95 @@
+import { A as StageCapability, I as StageSettings, U as ViewportPoint, z as StageViewState } from "./contract-CjHtrfJj.js";
+import { PageRef, Unsubscribe } from "@embedpdf/core";
+import { Camera, Camera as Camera$1, ScrollMetrics, Size, Size as Size$1 } from "@embedpdf/core-stage";
+import { Point as Point$1, Rect as Rect$1 } from "@embedpdf/core-geometry";
+//#region src/model.d.ts
+interface StageState extends StageSettings {
+  readonly camera: Camera;
+  /**
+   * One-way render-commit latch. False while the initial viewport-driven
+   * placement is unresolved; true only after its camera and settings writes
+   * have completed. Page and scroll screen-space reads refuse to answer while
+   * false, so an adapter can never paint the placeholder camera at the origin.
+   */
+  readonly placed: boolean;
+  /**
+   * Names of the responsive rules currently matching the box, in source order.
+   * State (not derived) so `matchesRule()` is reactive in every framework.
+   */
+  readonly activeRules: readonly string[];
+  /**
+   * False while the zoom is in motion, true once it has rested (about 150 ms
+   * of frames without a zoom write). Device-snapping of page origins is gated
+   * on this: a continuous zoom and a snapped origin cannot coexist without the
+   * anchor point jittering ±0.5 device px per step, so pages place
+   * fractionally while zooming and snap once at rest. Pans always snap (a pure
+   * translation has no anchor error).
+   */
+  readonly cameraResting: boolean;
+  /** The container size the host reported, in viewport px. */
+  readonly viewport: Size;
+  /**
+   * Device pixels per view pixel (web: `window.devicePixelRatio`). Feeds each
+   * page's transform so bitmaps render crisp and boxes land on the device
+   * grid. Defaults to 1.
+   */
+  readonly dpr: number;
+  /**
+   * The current page index, valid in both flows. Navigation sets it; in
+   * continuous flow manipulation derives it from the camera; in paged flow
+   * panning never moves it (the scene is a one-item slice at this page).
+   * An index, so it survives spread and layout regrouping.
+   */
+  readonly cursor: number;
+  /**
+   * What last drove the camera or cursor: `'programmatic'` for the arrival
+   * and reveal verbs (the ones action executors use), `'user'` for direct
+   * manipulation (wheel, drag, scrollbars, embedder scroll calls). The
+   * page-state feed hands it to the actions plugin, whose cascade budget
+   * counts only programmatic rounds, so user scrolling is never throttled.
+   */
+  readonly motionCause: 'user' | 'programmatic';
+}
+//#endregion
+//#region src/host-contract.d.ts
+/**
+ * The host lens: what the surface binding, the gesture controller and sibling
+ * plugins need. The same runtime token as the public contract, typed wider.
+ */
+interface StageHostCapability extends StageCapability {
+  /**
+   * Report the container box (ResizeObserver); the first real size triggers placement. After
+   * that, a box with no area (hidden, or taken out of the page) keeps the last real viewport.
+   */
+  setViewportSize(size: Size$1): void;
+  /** Report the device pixel ratio so page transforms render crisp. */
+  setDevicePixelRatio(ratio: number): void;
+  /** Bracket a direct-manipulation gesture (touch pan / pinch); `elastic` enables rubber-band. */
+  beginGesture(options?: {
+    elastic?: boolean;
+  }): void;
+  endGesture(): void;
+  /** Momentum pan from a release velocity in viewport px/s. */
+  fling(velocityX: number, velocityY: number): void;
+  /** The touch double-tap zoom ladder around a viewport point. */
+  doubleTapZoom(point: ViewportPoint): void;
+  /** Zoom by a factor holding a viewport point fixed — the pinch primitive. */
+  zoomAround(point: ViewportPoint, factor: number): void;
+  /** The camera as a native scroller, in viewport px. Reference-stable. */
+  getScrollMetrics(): ScrollMetrics;
+  worldToViewport(world: Point$1): ViewportPoint;
+  viewportToWorld(point: ViewportPoint): Point$1;
+  pageToWorld(page: PageRef, point: Point$1): Point$1 | null;
+  /** Offer a candidate initial view; the highest-priority non-null wins at placement. */
+  provideInitialView(priority: number, provider: () => StageViewState | null): Unsubscribe;
+  /** Resolve the registered providers once (else reset). Called when the viewport is ready. */
+  placeInitial(): void;
+  /** Re-resolve the zoom intent against the current scene (wired to the page registry). */
+  refit(): void;
+  /** This lens's identity — the stage plugin id; pointer samples are stamped with it. */
+  getLensId(): string;
+}
+declare const StageToken: import("@embedpdf/core").CapabilityToken<StageHostCapability>;
+//#endregion
+export { Size$1 as a, StageState as c, ScrollMetrics as i, Point$1 as n, StageHostCapability as o, Rect$1 as r, StageToken as s, Camera$1 as t };
+//# sourceMappingURL=host-contract-Du5tEZ4h.d.ts.map