@excalidraw/math 0.18.0-0457ac9 → 0.18.0-063e025

package/dist/types/excalidraw/viewport.d.ts

@@ -0,0 +1,316 @@
+import type { SceneBounds } from "@excalidraw/element";
+import type { Bounds } from "@excalidraw/common";
+import type { ExcalidrawElement, NonDeleted, NonDeletedSceneElementsMap } from "@excalidraw/element/types";
+import type { AppState, NormalizedZoomValue, Offsets, PointerCoords, ScrollConstraints, ViewportOffsets, Zoom } from "./types";
+export declare const SCROLL_TO_CONTENT_ANIMATION_KEY = "animateScrollToContent";
+/** default rubberband overscroll give for scroll locks, in viewport px */
+export declare const DEFAULT_OVERSCROLL = 150;
+export type AnimationOptions = {
+    duration?: number;
+};
+export type SetViewportRect = {
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+};
+export declare const isSetViewportRect: (target: unknown) => target is SetViewportRect;
+export type SetViewportOptions = {
+    /**
+     * what to show in the viewport: an explicit scene-coordinate box/rect,
+     * element(s), or an element id / element-link URL.
+     *
+     * IMPORTANT: if supplying ExcalidrawElement(s), only non-deleted elements
+     * that actually exist on the canvas are considered. If you want to navigate
+     * to elements that's not on canvas yet, supply their bounds by using
+     * `getCommonBounds` (see {@link getCommonBounds}).
+     */
+    target: Bounds | SetViewportRect | ExcalidrawElement | readonly ExcalidrawElement[] | string;
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/object-fit
+     *
+     * - `scale-down` - zoom out so the target fits the viewport, never zooming past 100%
+     * - `contain` - zoom the target so it fills the viewport (may exceed 100%)
+     * - `none` - keep the current zoom, only center the target in the viewport
+     */
+    fit?: "scale-down" | "contain" | "none";
+    lock?: {
+        /** constraints panning to the target box */
+        scroll?: ScrollConstraints["lockScroll"];
+        /** makes the resolved zoom the minimum zoom */
+        zoom?: ScrollConstraints["lockZoom"];
+        /**
+         * Rubberband give past the lock, in viewport px (zoom-independent): how
+         * far the user can pan beyond the constraint before snapping back.
+         * `true` (default) uses {@link DEFAULT_OVERSCROLL}, `false` disables
+         * (rigid lock), a number sets the give explicitly.
+         */
+        overscroll?: boolean | number;
+    };
+    animation?: AnimationOptions | boolean;
+    /**
+     * CSS-style per-side viewport insets, in viewport pixels
+     * (zoom-independent) — static values, editor-UI-derived (`ui`), or a
+     * combination. See {@link ViewportOffsets}.
+     */
+    offsets?: ViewportOffsets;
+};
+type Viewport = Pick<AppState, "scrollX" | "scrollY" | "zoom">;
+/**
+ * Clamps a proposed scroll/zoom against the active lock (`scrollConstraints`).
+ * Returns the input scroll/zoom unchanged when there is no lock.
+ * `overscroll` (screen px, zoom-independent) is rubberband give past the
+ * resting clamp — pass 0 for a hard clamp.
+ */
+export declare const constrainScrollState: (state: Pick<AppState, "scrollX" | "scrollY" | "zoom" | "width" | "height" | "scrollConstraints">, overscroll?: number) => Viewport;
+export declare const isViewportOverscrolled: (state: Pick<AppState, "scrollX" | "scrollY" | "zoom" | "width" | "height" | "scrollConstraints">) => boolean;
+/**
+ * Rubberband snap-back: animates the viewport from its current (possibly
+ * overscrolled) position back inside the lock box via the shared
+ * AnimationController. No-op when already within the hard bounds (or when there
+ * is no lock).
+ */
+export declare const animateToConstraints: (state: Pick<AppState, "scrollX" | "scrollY" | "zoom" | "width" | "height" | "scrollConstraints">, onFrame: (viewport: Pick<AppState, "scrollX" | "scrollY" | "zoom" | "shouldCacheIgnoreZoom">) => void, duration?: number) => void;
+/**
+ * Scrolls (and, per `fit`, zooms) the viewport so the given target box is in
+ * view, optionally animating the transition. `onComplete` runs once the
+ * viewport has settled on the target.
+ */
+export declare const setViewportToBounds: (state: AppState, bounds: Bounds, opts: Pick<SetViewportOptions, "fit" | "animation"> & {
+    offsets?: Offsets;
+}, onFrame: (state: Pick<AppState, "scrollX" | "scrollY" | "zoom" | "shouldCacheIgnoreZoom">) => void, onComplete?: () => void) => void;
+export declare const zoomToFitBounds: ({ bounds, appState, canvasOffsets, fit, minZoom, maxZoom, steppedZoom, }: {
+    bounds: SceneBounds;
+    canvasOffsets?: Offsets;
+    appState: Readonly<AppState>;
+    fit?: SetViewportOptions["fit"];
+    minZoom?: number;
+    maxZoom?: number;
+    steppedZoom?: boolean;
+}) => {
+    appState: {
+        scrollX: number;
+        scrollY: number;
+        zoom: {
+            value: NormalizedZoomValue;
+        };
+        contextMenu: {
+            items: import("./components/ContextMenu").ContextMenuItems;
+            top: number;
+            left: number;
+        } | null;
+        showWelcomeScreen: boolean;
+        isLoading: boolean;
+        errorMessage: React.ReactNode;
+        activeEmbeddable: {
+            element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
+            state: "hover" | "active";
+        } | null;
+        newElement: NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
+        resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
+        multiElement: NonDeleted<import("@excalidraw/element/types").ExcalidrawLinearElement> | null;
+        selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
+        isBindingEnabled: boolean;
+        boxSelectionMode: import("./types").BoxSelectionMode;
+        bindingPreference: "enabled" | "disabled";
+        isMidpointSnappingEnabled: boolean;
+        suggestedBinding: {
+            element: NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement>;
+            midPoint?: import("@excalidraw/math").GlobalPoint;
+        } | null;
+        frameToHighlight: NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
+        frameRendering: {
+            enabled: boolean;
+            name: boolean;
+            outline: boolean;
+            clip: boolean;
+        };
+        editingFrame: string | null;
+        elementsToHighlight: readonly import("@excalidraw/element/types").NonDeletedExcalidrawElement[] | null;
+        editingTextElement: import("@excalidraw/element/types").ExcalidrawTextElement | null;
+        activeTool: {
+            lastActiveTool: import("./types").ActiveTool | null;
+            locked: boolean;
+            fromSelection: boolean;
+        } & import("./types").ActiveTool;
+        preferredSelectionTool: {
+            type: "selection" | "lasso";
+            initialized: boolean;
+        };
+        penMode: boolean;
+        penDetected: boolean;
+        exportBackground: boolean;
+        exportEmbedScene: boolean;
+        exportWithDarkMode: boolean;
+        exportScale: number;
+        currentItemStrokeColor: string;
+        currentItemBackgroundColor: string;
+        currentItemFillStyle: ExcalidrawElement["fillStyle"];
+        currentItemStrokeWidthKey: import("@excalidraw/common").StrokeWidthKey;
+        currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
+        currentItemRoughness: number;
+        currentItemStrokeVariability: import("@excalidraw/element/types").StrokeVariability;
+        currentItemOpacity: number;
+        currentItemFontFamily: import("@excalidraw/element/types").FontFamilyValues;
+        currentItemFontSize: number;
+        currentItemTextAlign: import("@excalidraw/element/types").TextAlign;
+        currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
+        currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
+        currentHoveredFontFamily: import("@excalidraw/element/types").FontFamilyValues | null;
+        currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
+        currentItemArrowType: "sharp" | "round" | "elbow";
+        viewBackgroundColor: string;
+        scrollConstraints: ScrollConstraints | null;
+        cursorButton: "up" | "down";
+        scrolledOutside: boolean;
+        name: string | null;
+        isResizing: boolean;
+        isRotating: boolean;
+        openMenu: "canvas" | null;
+        openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
+        openSidebar: {
+            name: import("./types").SidebarName;
+            tab?: import("./types").SidebarTabName;
+        } | null;
+        openDialog: null | {
+            name: "imageExport" | "help" | "jsonExport";
+        } | {
+            name: "ttd";
+            tab: "text-to-diagram" | "mermaid";
+        } | {
+            name: "commandPalette";
+        } | {
+            name: "settings";
+        } | {
+            name: "elementLinkSelector";
+            sourceElementId: ExcalidrawElement["id"];
+        } | {
+            name: "charts";
+            data: import("./charts").Spreadsheet;
+            rawText: string;
+        };
+        defaultSidebarDockedPreference: boolean;
+        lastPointerDownWith: import("@excalidraw/element/types").PointerType;
+        selectedElementIds: Readonly<{
+            [id: string]: true;
+        }>;
+        hoveredElementIds: Readonly<{
+            [id: string]: true;
+        }>;
+        previousSelectedElementIds: {
+            [id: string]: true;
+        };
+        selectedElementsAreBeingDragged: boolean;
+        shouldCacheIgnoreZoom: boolean;
+        toast: {
+            message: React.ReactNode;
+            closable?: boolean;
+            duration?: number;
+        } | null;
+        zenModeEnabled: boolean;
+        theme: import("@excalidraw/element/types").Theme;
+        gridSize: number;
+        gridStep: number;
+        gridModeEnabled: boolean;
+        viewModeEnabled: boolean;
+        selectedGroupIds: {
+            [groupId: string]: boolean;
+        };
+        editingGroupId: import("@excalidraw/element/types").GroupId | null;
+        width: number;
+        height: number;
+        offsetTop: number;
+        offsetLeft: number;
+        fileHandle: FileSystemFileHandle | null;
+        collaborators: Map<import("./types").SocketId, import("./types").Collaborator>;
+        stats: {
+            open: boolean;
+            panels: number;
+        };
+        showHyperlinkPopup: false | "info" | "editor";
+        selectedLinearElement: import("@excalidraw/element").LinearElementEditor | null;
+        snapLines: readonly import("./snapping").SnapLine[];
+        originSnapOffset: {
+            x: number;
+            y: number;
+        } | null;
+        objectsSnapModeEnabled: boolean;
+        userToFollow: import("./types").UserToFollow | null;
+        followedBy: Set<import("./types").SocketId>;
+        isCropping: boolean;
+        croppingElementId: ExcalidrawElement["id"] | null;
+        searchMatches: Readonly<{
+            focusedId: ExcalidrawElement["id"] | null;
+            matches: readonly import("./types").SearchMatch[];
+        }> | null;
+        activeLockedId: string | null;
+        lockedMultiSelections: {
+            [groupId: string]: true;
+        };
+        bindMode: import("@excalidraw/element/types").BindMode;
+    };
+    captureUpdate: "EVENTUALLY";
+};
+/** Computes the viewport (scroll + zoom) that brings the target box into view,
+ * based on the requested fit behavior. */
+export declare const getTargetViewport: (state: AppState, bounds: Bounds, fit?: SetViewportOptions["fit"], offsets?: Offsets) => Viewport;
+export type ResolvedViewportTarget = {
+    /** null when the target couldn't be resolved (unknown id/link, or all
+     * supplied elements deleted) */
+    bounds: Bounds | null;
+    /** how the target was specified, so callers can react to unresolved
+     * targets themselves (e.g. toast on a broken element link) */
+    type: "element" | "area" | "link";
+};
+/** Resolves a `setViewport` target to a scene-coordinate box. */
+export declare const resolveViewportTarget: (target: SetViewportOptions["target"], elementsMap: NonDeletedSceneElementsMap, appState: Pick<AppState, "width" | "height">) => ResolvedViewportTarget;
+/** Computes the viewport patch for landing on `bounds`: the target
+ * scroll/zoom, plus the scroll lock to install — or `scrollConstraints: null`
+ * to clear a previous lock when none is requested. */
+export declare const getConstrainedTargetViewport: (appState: AppState, bounds: Bounds, { fit, offsets, lock, }: Pick<SetViewportOptions, "fit" | "lock"> & {
+    offsets?: Offsets;
+}) => Viewport & {
+    scrollConstraints: ScrollConstraints | null;
+};
+/**
+ * Interpolates the viewport from `from` to `target` at the (already-eased)
+ * blend amount `factor` (0 = `from`, 1 = `target`).
+ *
+ * Zoom is interpolated geometrically (so it feels uniform), but the pan can't
+ * simply lerp alongside it: pairing a geometric zoom with a linear scroll (or
+ * a linearly-tweened focal point) makes scene points swoop along curved,
+ * non-monotone screen paths once the zoom ratio exceeds ~e (the destination
+ * visibly drifts away before converging). Instead we interpolate the view
+ * transform affinely — a scene point maps to screen as
+ * `(scenePt + scroll) * zoom`, and requiring every point to travel a straight
+ * screen line forces `zoom` to be a convex blend `(1-m)*z0 + m*z1` with
+ * `scroll * zoom` lerped by that same weight. Deriving `m` from the geometric
+ * zoom keeps its pacing while making all screen trajectories straight and
+ * monotone.
+ */
+export declare const interpolateViewport: ({ from, target, factor, }: {
+    from: Viewport;
+    target: Viewport;
+    factor: number;
+}) => Viewport;
+export declare const getClosestElementBounds: (elements: readonly ExcalidrawElement[], from: {
+    x: number;
+    y: number;
+}) => Bounds;
+export declare const centerScrollOn: ({ scenePoint, viewportDimensions, zoom, offsets, }: {
+    scenePoint: PointerCoords;
+    viewportDimensions: {
+        height: number;
+        width: number;
+    };
+    zoom: Zoom;
+    offsets?: Offsets;
+}) => {
+    scrollX: number;
+    scrollY: number;
+};
+export declare const getScrollToContentState: (elements: readonly ExcalidrawElement[], appState: AppState) => {
+    scrollX: number;
+    scrollY: number;
+};
+export {};

package/dist/types/excalidraw/wysiwyg/textWysiwyg.d.ts

@@ -1,8 +1,7 @@
-import type { ExcalidrawElement, ExcalidrawTextElement } from "@excalidraw/element/types";
+import type { ExcalidrawTextElement } from "@excalidraw/element/types";
 import type App from "../components/App";
 type SubmitHandler = () => void;
-export declare const textWysiwyg: ({ id, onChange, onSubmit, getViewportCoords, element, canvas, excalidrawContainer, app, autoSelect, initialCaretSceneCoords, }: {
-    id: ExcalidrawElement["id"];
+export declare const textWysiwyg: ({ onChange, onSubmit, getViewportCoords, element, canvas, excalidrawContainer, app, autoSelect, initialCaretSceneCoords, }: {
     /**
      * textWysiwyg only deals with `originalText`
      *

package/dist/types/laser-pointer/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./state";
+export type { Point } from "./math";

package/dist/types/laser-pointer/src/math.d.ts

@@ -0,0 +1,16 @@
+export type Point = [x: number, y: number, r: number];
+export declare function add([ax, ay, ar]: Point, [bx, by, br]: Point): Point;
+export declare function sub([ax, ay, ar]: Point, [bx, by, br]: Point): Point;
+export declare function smul([x, y, r]: Point, s: number): Point;
+export declare function norm([x, y, r]: Point): Point;
+export declare function rot([x, y, r]: Point, rad: number): Point;
+export declare function plerp(a: Point, b: Point, t: number): Point;
+export declare function lerp(a: number, b: number, t: number): number;
+export declare function angle(p: Point, p1: Point, p2: Point): number;
+export declare function normAngle(a: number): number;
+export declare function mag([x, y]: Point): number;
+export declare function dist([ax, ay]: Point, [bx, by]: Point): number;
+export declare function getCircleAndPerpendicularLineIntersectionsAtPoint(point: Point, direction: Point, radius: number): [Point, Point];
+export declare function runLength(ps: Point[]): number;
+export declare const clamp: (v: number, min: number, max: number) => number;
+export declare function distancePointToSegment(p3: Point, p1: Point, p2: Point): number;

package/dist/types/laser-pointer/src/simplify.d.ts

@@ -0,0 +1,2 @@
+import { type Point } from "./math";
+export declare function douglasPeucker(points: Point[], epsilon: number): Point[];

package/dist/types/laser-pointer/src/state.d.ts

@@ -0,0 +1,35 @@
+import type { Point } from "./math";
+export type SizeMappingDetails = {
+    pressure: number;
+    runningLength: number;
+    currentIndex: number;
+    totalLength: number;
+};
+export type LaserPointerOptions = {
+    size: number;
+    streamline: number;
+    simplify: number;
+    simplifyPhase: "tail" | "output" | "input";
+    keepHead: boolean;
+    sizeMapping: (details: SizeMappingDetails) => number;
+};
+export declare class LaserPointer {
+    static defaults: LaserPointerOptions;
+    static constants: {
+        cornerDetectionMaxAngle: number;
+        cornerDetectionVariance: (s: number) => 1 | 0.5;
+        maxTailLength: number;
+    };
+    options: LaserPointerOptions;
+    constructor(options: Partial<LaserPointerOptions>);
+    originalPoints: Point[];
+    private stablePoints;
+    private tailPoints;
+    private isFresh;
+    private get lastPoint();
+    addPoint(point: Point): void;
+    close(): void;
+    stabilizeTail(): void;
+    private getSize;
+    getStrokeOutline(sizeOverride?: number | undefined): Point[];
+}

package/dist/types/utils/src/export.d.ts

@@ -1,13 +1,13 @@
 import { MIME_TYPES } from "@excalidraw/common";
-import type { ExcalidrawElement, ExcalidrawFrameLikeElement, NonDeleted } from "@excalidraw/element/types";
+import type { ExcalidrawFrameLikeElement, NonDeleted, NonDeletedExcalidrawElement } from "@excalidraw/element/types";
 import type { AppState, BinaryFiles } from "@excalidraw/excalidraw/types";
 export { MIME_TYPES };
 type ExportOpts = {
-    elements: readonly NonDeleted<ExcalidrawElement>[];
+    elements: readonly NonDeletedExcalidrawElement[];
     appState?: Partial<Omit<AppState, "offsetTop" | "offsetLeft">>;
     files: BinaryFiles | null;
     maxWidthOrHeight?: number;
-    exportingFrame?: ExcalidrawFrameLikeElement | null;
+    exportingFrame?: NonDeleted<ExcalidrawFrameLikeElement> | null;
     getDimensions?: (width: number, height: number) => {
         width: number;
         height: number;

package/dist/types/utils/src/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./export";
-export * from "./withinBounds";
-export * from "./bbox";
+export { elementsOverlappingBBox } from "@excalidraw/element";
 export { getCommonBounds } from "@excalidraw/element";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@excalidraw/math",
-  "version": "0.18.0-0457ac9",
+  "version": "0.18.0-063e025",
   "type": "module",
   "types": "./dist/types/math/src/index.d.ts",
   "main": "./dist/prod/index.js",
@@ -61,6 +61,6 @@
     "build:esm": "rimraf dist && node ../../scripts/buildBase.js && yarn gen:types"
   },
   "dependencies": {
-    "@excalidraw/common": "0.18.0-0457ac9"
+    "@excalidraw/common": "0.18.0-063e025"
   }
 }

package/dist/types/excalidraw/animation-frame-handler.d.ts

@@ -1,16 +0,0 @@
-export type AnimationCallback = (timestamp: number) => void | boolean;
-export type AnimationTarget = {
-    callback: AnimationCallback;
-    stopped: boolean;
-};
-export declare class AnimationFrameHandler {
-    private targets;
-    private rafIds;
-    register(key: object, callback: AnimationCallback): void;
-    start(key: object): void;
-    stop(key: object): void;
-    private constructFrame;
-    private scheduleFrame;
-    private cancelFrame;
-    private onFrame;
-}

package/dist/types/excalidraw/scene/scroll.d.ts

@@ -1,18 +0,0 @@
-import type { ExcalidrawElement } from "@excalidraw/element/types";
-import type { AppState, Offsets, PointerCoords, Zoom } from "../types";
-export declare const centerScrollOn: ({ scenePoint, viewportDimensions, zoom, offsets, }: {
-    scenePoint: PointerCoords;
-    viewportDimensions: {
-        height: number;
-        width: number;
-    };
-    zoom: Zoom;
-    offsets?: Offsets;
-}) => {
-    scrollX: number;
-    scrollY: number;
-};
-export declare const calculateScrollCenter: (elements: readonly ExcalidrawElement[], appState: AppState) => {
-    scrollX: number;
-    scrollY: number;
-};

package/dist/types/utils/src/bbox.d.ts

@@ -1,9 +0,0 @@
-import { type GlobalPoint, type LocalPoint } from "@excalidraw/math";
-import type { Bounds } from "@excalidraw/common";
-export type LineSegment<P extends LocalPoint | GlobalPoint> = [P, P];
-export declare function getBBox<P extends LocalPoint | GlobalPoint>(line: LineSegment<P>): Bounds;
-export declare function doBBoxesIntersect(a: Bounds, b: Bounds): boolean;
-export declare function isPointOnLine<P extends GlobalPoint | LocalPoint>(l: LineSegment<P>, p: P): boolean;
-export declare function isPointRightOfLine<P extends GlobalPoint | LocalPoint>(l: LineSegment<P>, p: P): boolean;
-export declare function isLineSegmentTouchingOrCrossingLine<P extends GlobalPoint | LocalPoint>(a: LineSegment<P>, b: LineSegment<P>): boolean;
-export declare function doLineSegmentsIntersect<P extends GlobalPoint | LocalPoint>(a: LineSegment<P>, b: LineSegment<P>): boolean;

package/dist/types/utils/src/withinBounds.d.ts

@@ -1,19 +0,0 @@
-import { type Bounds } from "@excalidraw/common";
-import type { ExcalidrawElement, NonDeletedExcalidrawElement } from "@excalidraw/element/types";
-type Element = NonDeletedExcalidrawElement;
-type Elements = readonly NonDeletedExcalidrawElement[];
-export declare const isElementInsideBBox: (element: Element, bbox: Bounds, eitherDirection?: boolean) => boolean;
-export declare const elementPartiallyOverlapsWithOrContainsBBox: (element: Element, bbox: Bounds) => boolean;
-export declare const elementsOverlappingBBox: ({ elements, bounds, type, errorMargin, }: {
-    elements: Elements;
-    bounds: Bounds | ExcalidrawElement;
-    /** safety offset. Defaults to 0. */
-    errorMargin?: number;
-    /**
-     * - overlap: elements overlapping or inside bounds
-     * - contain: elements inside bounds or bounds inside elements
-     * - inside: elements inside bounds
-     **/
-    type: "overlap" | "contain" | "inside";
-}) => NonDeletedExcalidrawElement[];
-export {};