@zsviczian/excalidraw 0.17.6-2 → 0.17.6-20

package/types/excalidraw/scene/export.d.ts

@@ -1,29 +1,30 @@
-import type { ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "../element/types";
-import type { AppState, BinaryFiles } from "../types";
-export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, exportingFrame, }: {
-    exportBackground: boolean;
-    exportPadding?: number | undefined;
-    viewBackgroundColor: string;
-    exportingFrame?: ExcalidrawFrameLikeElement | null | undefined;
-}, createCanvas?: (width: number, height: number) => {
-    canvas: HTMLCanvasElement;
-    scale: number;
-}, loadFonts?: () => Promise<void>) => Promise<HTMLCanvasElement>;
-export declare const exportToSvg: (elements: readonly NonDeletedExcalidrawElement[], appState: {
-    exportBackground: boolean;
-    exportPadding?: number;
-    exportScale?: number;
-    viewBackgroundColor: string;
-    exportWithDarkMode?: boolean;
-    exportEmbedScene?: boolean;
-    frameRendering?: AppState["frameRendering"];
-    frameColor?: AppState["frameColor"];
-}, files: BinaryFiles | null, opts?: {
-    /**
-     * if true, all embeddables passed in will be rendered when possible.
-     */
-    renderEmbeddables?: boolean;
-    exportingFrame?: ExcalidrawFrameLikeElement | null;
-    skipInliningFonts?: true;
-}) => Promise<SVGSVGElement>;
-export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];
+import type { ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "../element/types";
+import type { AppState, BinaryFiles } from "../types";
+export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, exportingFrame, }: {
+    exportBackground: boolean;
+    exportPadding?: number | undefined;
+    viewBackgroundColor: string;
+    exportingFrame?: ExcalidrawFrameLikeElement | null | undefined;
+}, createCanvas?: (width: number, height: number) => {
+    canvas: HTMLCanvasElement;
+    scale: number;
+}, loadFonts?: () => Promise<void>) => Promise<HTMLCanvasElement>;
+export declare const exportToSvg: (elements: readonly NonDeletedExcalidrawElement[], appState: {
+    exportBackground: boolean;
+    exportPadding?: number;
+    exportScale?: number;
+    viewBackgroundColor: string;
+    exportWithDarkMode?: boolean;
+    exportEmbedScene?: boolean;
+    frameRendering?: AppState["frameRendering"];
+    frameColor?: AppState["frameColor"];
+}, files: BinaryFiles | null, opts?: {
+    /**
+     * if true, all embeddables passed in will be rendered when possible.
+     */
+    renderEmbeddables?: boolean;
+    exportingFrame?: ExcalidrawFrameLikeElement | null;
+    skipInliningFonts?: true;
+    reuseImages?: boolean;
+}) => Promise<SVGSVGElement>;
+export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];

package/types/excalidraw/scene/index.d.ts

@@ -1,4 +1,4 @@
-export { isSomeElementSelected, getElementsWithinSelection, getCommonAttributeOfSelectedElements, getSelectedElements, getTargetElements, } from "./selection";
-export { calculateScrollCenter } from "./scroll";
-export { hasBackground, hasStrokeWidth, hasStrokeStyle, canHaveArrowheads, canChangeRoundness, getElementAtPosition, getElementsAtPosition, } from "./comparisons";
-export { getNormalizedZoom, getNormalizedGridSize, getNormalizedGridStep, } from "./normalize";
+export { isSomeElementSelected, getElementsWithinSelection, getCommonAttributeOfSelectedElements, getSelectedElements, getTargetElements, } from "./selection";
+export { calculateScrollCenter } from "./scroll";
+export { hasBackground, hasStrokeWidth, hasStrokeStyle, canHaveArrowheads, canChangeRoundness, getElementAtPosition, getElementsAtPosition, } from "./comparisons";
+export { getNormalizedZoom, getNormalizedGridSize, getNormalizedGridStep, } from "./normalize";

package/types/excalidraw/scene/normalize.d.ts

@@ -1,4 +1,4 @@
-import type { NormalizedZoomValue } from "../types";
-export declare const getNormalizedZoom: (zoom: number) => NormalizedZoomValue;
-export declare const getNormalizedGridSize: (gridStep: number) => number;
-export declare const getNormalizedGridStep: (gridStep: number) => number;
+import type { NormalizedZoomValue } from "../types";
+export declare const getNormalizedZoom: (zoom: number) => NormalizedZoomValue;
+export declare const getNormalizedGridSize: (gridStep: number) => number;
+export declare const getNormalizedGridStep: (gridStep: number) => number;

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

@@ -1,23 +1,23 @@
-import type { AppState, Offsets, PointerCoords, Zoom } from "../types";
-import type { ExcalidrawElement } from "../element/types";
-export declare const centerScrollOn: ({ scenePoint, viewportDimensions, zoom, offsets, }: {
-    scenePoint: PointerCoords;
-    viewportDimensions: {
-        height: number;
-        width: number;
-    };
-    zoom: Zoom;
-    offsets?: Partial<{
-        top: number;
-        right: number;
-        bottom: number;
-        left: number;
-    }> | undefined;
-}) => {
-    scrollX: number;
-    scrollY: number;
-};
-export declare const calculateScrollCenter: (elements: readonly ExcalidrawElement[], appState: AppState) => {
-    scrollX: number;
-    scrollY: number;
-};
+import type { AppState, Offsets, PointerCoords, Zoom } from "../types";
+import type { ExcalidrawElement } from "../element/types";
+export declare const centerScrollOn: ({ scenePoint, viewportDimensions, zoom, offsets, }: {
+    scenePoint: PointerCoords;
+    viewportDimensions: {
+        height: number;
+        width: number;
+    };
+    zoom: Zoom;
+    offsets?: Partial<{
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    }> | undefined;
+}) => {
+    scrollX: number;
+    scrollY: number;
+};
+export declare const calculateScrollCenter: (elements: readonly ExcalidrawElement[], appState: AppState) => {
+    scrollX: number;
+    scrollY: number;
+};

package/types/excalidraw/scene/scrollbars.d.ts

@@ -1,12 +1,12 @@
-import type { InteractiveCanvasAppState } from "../types";
-import type { ScrollBars } from "./types";
-import type { ExcalidrawElement } from "../element/types";
-export declare const SCROLLBAR_MARGIN = 4;
-export declare const SCROLLBAR_WIDTH = 6;
-export declare const SCROLLBAR_COLOR = "rgba(128,128,128,0.3)";
-export declare const getScrollBars: (elements: readonly ExcalidrawElement[], viewportWidth: number, viewportHeight: number, appState: InteractiveCanvasAppState) => ScrollBars;
-export declare const isOverScrollBars: (scrollBars: ScrollBars, x: number, y: number) => {
-    isOverEither: boolean;
-    isOverHorizontal: boolean;
-    isOverVertical: boolean;
-};
+import type { InteractiveCanvasAppState } from "../types";
+import type { ScrollBars } from "./types";
+import type { ExcalidrawElement } from "../element/types";
+export declare const SCROLLBAR_MARGIN = 4;
+export declare const SCROLLBAR_WIDTH = 6;
+export declare const SCROLLBAR_COLOR = "rgba(128,128,128,0.3)";
+export declare const getScrollBars: (elements: readonly ExcalidrawElement[], viewportWidth: number, viewportHeight: number, appState: InteractiveCanvasAppState) => ScrollBars;
+export declare const isOverScrollBars: (scrollBars: ScrollBars, x: number, y: number) => {
+    isOverEither: boolean;
+    isOverHorizontal: boolean;
+    isOverVertical: boolean;
+};

package/types/excalidraw/scene/selection.d.ts

@@ -1,32 +1,32 @@
-import type { ElementsMap, ElementsMapOrArray, ExcalidrawElement, NonDeletedExcalidrawElement } from "../element/types";
-import type { AppState, InteractiveCanvasAppState } from "../types";
-/**
- * Frames and their containing elements are not to be selected at the same time.
- * Given an array of selected elements, if there are frames and their containing elements
- * we only keep the frames.
- * @param selectedElements
- */
-export declare const excludeElementsInFramesFromSelection: <T extends ExcalidrawElement>(selectedElements: readonly T[]) => T[];
-export declare const getElementsWithinSelection: (elements: readonly NonDeletedExcalidrawElement[], selection: NonDeletedExcalidrawElement, elementsMap: ElementsMap, excludeElementsInFrames?: boolean) => NonDeletedExcalidrawElement[];
-export declare const getVisibleAndNonSelectedElements: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => NonDeletedExcalidrawElement[];
-export declare const isSomeElementSelected: {
-    (elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">): boolean;
-    clearCache(): void;
-};
-/**
- * Returns common attribute (picked by `getAttribute` callback) of selected
- *  elements. If elements don't share the same value, returns `null`.
- */
-export declare const getCommonAttributeOfSelectedElements: <T>(elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">, getAttribute: (element: ExcalidrawElement) => T) => T | null;
-export declare const getSelectedElements: (elements: ElementsMapOrArray, appState: Pick<InteractiveCanvasAppState, "selectedElementIds">, opts?: {
-    includeBoundTextElement?: boolean;
-    includeElementsInFrames?: boolean;
-}) => ExcalidrawElement[];
-export declare const getTargetElements: (elements: ElementsMapOrArray, appState: Pick<AppState, "selectedElementIds" | "editingTextElement" | "newElement">) => ExcalidrawElement[];
-/**
- * returns prevState's selectedElementids if no change from previous, so as to
- * retain reference identity for memoization
- */
-export declare const makeNextSelectedElementIds: (nextSelectedElementIds: AppState["selectedElementIds"], prevState: Pick<AppState, "selectedElementIds">) => Readonly<{
-    [id: string]: true;
-}>;
+import type { ElementsMap, ElementsMapOrArray, ExcalidrawElement, NonDeletedExcalidrawElement } from "../element/types";
+import type { AppState, InteractiveCanvasAppState } from "../types";
+/**
+ * Frames and their containing elements are not to be selected at the same time.
+ * Given an array of selected elements, if there are frames and their containing elements
+ * we only keep the frames.
+ * @param selectedElements
+ */
+export declare const excludeElementsInFramesFromSelection: <T extends ExcalidrawElement>(selectedElements: readonly T[]) => T[];
+export declare const getElementsWithinSelection: (elements: readonly NonDeletedExcalidrawElement[], selection: NonDeletedExcalidrawElement, elementsMap: ElementsMap, excludeElementsInFrames?: boolean) => NonDeletedExcalidrawElement[];
+export declare const getVisibleAndNonSelectedElements: (elements: readonly NonDeletedExcalidrawElement[], selectedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, elementsMap: ElementsMap) => NonDeletedExcalidrawElement[];
+export declare const isSomeElementSelected: {
+    (elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">): boolean;
+    clearCache(): void;
+};
+/**
+ * Returns common attribute (picked by `getAttribute` callback) of selected
+ *  elements. If elements don't share the same value, returns `null`.
+ */
+export declare const getCommonAttributeOfSelectedElements: <T>(elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">, getAttribute: (element: ExcalidrawElement) => T) => T | null;
+export declare const getSelectedElements: (elements: ElementsMapOrArray, appState: Pick<InteractiveCanvasAppState, "selectedElementIds">, opts?: {
+    includeBoundTextElement?: boolean;
+    includeElementsInFrames?: boolean;
+}) => ExcalidrawElement[];
+export declare const getTargetElements: (elements: ElementsMapOrArray, appState: Pick<AppState, "selectedElementIds" | "editingTextElement" | "newElement">) => ExcalidrawElement[];
+/**
+ * returns prevState's selectedElementids if no change from previous, so as to
+ * retain reference identity for memoization
+ */
+export declare const makeNextSelectedElementIds: (nextSelectedElementIds: AppState["selectedElementIds"], prevState: Pick<AppState, "selectedElementIds">) => Readonly<{
+    [id: string]: true;
+}>;

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

@@ -1,112 +1,119 @@
-import type { RoughCanvas } from "roughjs/bin/canvas";
-import type { Drawable } from "roughjs/bin/core";
-import type { ExcalidrawElement, NonDeletedElementsMap, NonDeletedExcalidrawElement, NonDeletedSceneElementsMap } from "../element/types";
-import type { AppClassProperties, AppState, EmbedsValidationStatus, ElementsPendingErasure, InteractiveCanvasAppState, StaticCanvasAppState, SocketId, UserIdleState, Device, PendingExcalidrawElements } from "../types";
-import type { MakeBrand } from "../utility-types";
-export type RenderableElementsMap = NonDeletedElementsMap & MakeBrand<"RenderableElementsMap">;
-export type StaticCanvasRenderConfig = {
-    canvasBackgroundColor: AppState["viewBackgroundColor"];
-    imageCache: AppClassProperties["imageCache"];
-    renderGrid: boolean;
-    /** when exporting the behavior is slightly different (e.g. we can't use
-     CSS filters), and we disable render optimizations for best output */
-    isExporting: boolean;
-    embedsValidationStatus: EmbedsValidationStatus;
-    elementsPendingErasure: ElementsPendingErasure;
-    pendingFlowchartNodes: PendingExcalidrawElements | null;
-    isHighlighterPenDrawing?: boolean;
-};
-export type SVGRenderConfig = {
-    offsetX: number;
-    offsetY: number;
-    isExporting: boolean;
-    exportWithDarkMode: boolean;
-    renderEmbeddables: boolean;
-    frameRendering: AppState["frameRendering"];
-    canvasBackgroundColor: AppState["viewBackgroundColor"];
-    frameColor?: AppState["frameColor"];
-    embedsValidationStatus: EmbedsValidationStatus;
-};
-export type InteractiveCanvasRenderConfig = {
-    remoteSelectedElementIds: Map<ExcalidrawElement["id"], SocketId[]>;
-    remotePointerViewportCoords: Map<SocketId, {
-        x: number;
-        y: number;
-    }>;
-    remotePointerUserStates: Map<SocketId, UserIdleState>;
-    remotePointerUsernames: Map<SocketId, string>;
-    remotePointerButton: Map<SocketId, string | undefined>;
-    selectionColor: string;
-    renderScrollbars?: boolean;
-};
-export type RenderInteractiveSceneCallback = {
-    atLeastOneVisibleElement: boolean;
-    elementsMap: RenderableElementsMap;
-    scrollBars?: ScrollBars;
-};
-export type StaticSceneRenderConfig = {
-    canvas: HTMLCanvasElement;
-    rc: RoughCanvas;
-    elementsMap: RenderableElementsMap;
-    allElementsMap: NonDeletedSceneElementsMap;
-    visibleElements: readonly NonDeletedExcalidrawElement[];
-    scale: number;
-    appState: StaticCanvasAppState;
-    renderConfig: StaticCanvasRenderConfig;
-};
-export type InteractiveSceneRenderConfig = {
-    canvas: HTMLCanvasElement | null;
-    elementsMap: RenderableElementsMap;
-    visibleElements: readonly NonDeletedExcalidrawElement[];
-    selectedElements: readonly NonDeletedExcalidrawElement[];
-    allElementsMap: NonDeletedSceneElementsMap;
-    scale: number;
-    appState: InteractiveCanvasAppState;
-    renderConfig: InteractiveCanvasRenderConfig;
-    device: Device;
-    callback: (data: RenderInteractiveSceneCallback) => void;
-};
-export type NewElementSceneRenderConfig = {
-    canvas: HTMLCanvasElement | null;
-    rc: RoughCanvas;
-    newElement: ExcalidrawElement | null;
-    elementsMap: RenderableElementsMap;
-    allElementsMap: NonDeletedSceneElementsMap;
-    scale: number;
-    appState: AppState;
-    renderConfig: StaticCanvasRenderConfig;
-};
-export type SceneScroll = {
-    scrollX: number;
-    scrollY: number;
-};
-export type ExportType = "png" | "clipboard" | "clipboard-svg" | "backend" | "svg";
-export type ScrollBars = {
-    horizontal: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    } | null;
-    vertical: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    } | null;
-};
-export type ElementShape = Drawable | Drawable[] | null;
-export type ElementShapes = {
-    rectangle: Drawable;
-    ellipse: Drawable;
-    diamond: Drawable;
-    iframe: Drawable;
-    embeddable: Drawable;
-    freedraw: Drawable | null;
-    arrow: Drawable[];
-    line: Drawable[];
-    text: null;
-    image: null;
-    frame: null;
-    magicframe: null;
-};
+import type { RoughCanvas } from "roughjs/bin/canvas";
+import type { Drawable } from "roughjs/bin/core";
+import type { ExcalidrawElement, NonDeletedElementsMap, NonDeletedExcalidrawElement, NonDeletedSceneElementsMap } from "../element/types";
+import type { AppClassProperties, AppState, EmbedsValidationStatus, ElementsPendingErasure, InteractiveCanvasAppState, StaticCanvasAppState, SocketId, UserIdleState, Device, PendingExcalidrawElements } from "../types";
+import type { MakeBrand } from "../utility-types";
+export type RenderableElementsMap = NonDeletedElementsMap & MakeBrand<"RenderableElementsMap">;
+export type StaticCanvasRenderConfig = {
+    canvasBackgroundColor: AppState["viewBackgroundColor"];
+    imageCache: AppClassProperties["imageCache"];
+    renderGrid: boolean;
+    /** when exporting the behavior is slightly different (e.g. we can't use
+     CSS filters), and we disable render optimizations for best output */
+    isExporting: boolean;
+    embedsValidationStatus: EmbedsValidationStatus;
+    elementsPendingErasure: ElementsPendingErasure;
+    pendingFlowchartNodes: PendingExcalidrawElements | null;
+    isHighlighterPenDrawing?: boolean;
+};
+export type SVGRenderConfig = {
+    offsetX: number;
+    offsetY: number;
+    isExporting: boolean;
+    exportWithDarkMode: boolean;
+    renderEmbeddables: boolean;
+    frameRendering: AppState["frameRendering"];
+    canvasBackgroundColor: AppState["viewBackgroundColor"];
+    frameColor?: AppState["frameColor"];
+    embedsValidationStatus: EmbedsValidationStatus;
+    /**
+     * whether to attempt to reuse images as much as possible through symbols
+     * (reduces SVG size, but may be incompoatible with some SVG renderers)
+     *
+     * @default true
+     */
+    reuseImages: boolean;
+};
+export type InteractiveCanvasRenderConfig = {
+    remoteSelectedElementIds: Map<ExcalidrawElement["id"], SocketId[]>;
+    remotePointerViewportCoords: Map<SocketId, {
+        x: number;
+        y: number;
+    }>;
+    remotePointerUserStates: Map<SocketId, UserIdleState>;
+    remotePointerUsernames: Map<SocketId, string>;
+    remotePointerButton: Map<SocketId, string | undefined>;
+    selectionColor: string;
+    renderScrollbars?: boolean;
+};
+export type RenderInteractiveSceneCallback = {
+    atLeastOneVisibleElement: boolean;
+    elementsMap: RenderableElementsMap;
+    scrollBars?: ScrollBars;
+};
+export type StaticSceneRenderConfig = {
+    canvas: HTMLCanvasElement;
+    rc: RoughCanvas;
+    elementsMap: RenderableElementsMap;
+    allElementsMap: NonDeletedSceneElementsMap;
+    visibleElements: readonly NonDeletedExcalidrawElement[];
+    scale: number;
+    appState: StaticCanvasAppState;
+    renderConfig: StaticCanvasRenderConfig;
+};
+export type InteractiveSceneRenderConfig = {
+    canvas: HTMLCanvasElement | null;
+    elementsMap: RenderableElementsMap;
+    visibleElements: readonly NonDeletedExcalidrawElement[];
+    selectedElements: readonly NonDeletedExcalidrawElement[];
+    allElementsMap: NonDeletedSceneElementsMap;
+    scale: number;
+    appState: InteractiveCanvasAppState;
+    renderConfig: InteractiveCanvasRenderConfig;
+    device: Device;
+    callback: (data: RenderInteractiveSceneCallback) => void;
+};
+export type NewElementSceneRenderConfig = {
+    canvas: HTMLCanvasElement | null;
+    rc: RoughCanvas;
+    newElement: ExcalidrawElement | null;
+    elementsMap: RenderableElementsMap;
+    allElementsMap: NonDeletedSceneElementsMap;
+    scale: number;
+    appState: AppState;
+    renderConfig: StaticCanvasRenderConfig;
+};
+export type SceneScroll = {
+    scrollX: number;
+    scrollY: number;
+};
+export type ExportType = "png" | "clipboard" | "clipboard-svg" | "backend" | "svg";
+export type ScrollBars = {
+    horizontal: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    } | null;
+    vertical: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    } | null;
+};
+export type ElementShape = Drawable | Drawable[] | null;
+export type ElementShapes = {
+    rectangle: Drawable;
+    ellipse: Drawable;
+    diamond: Drawable;
+    iframe: Drawable;
+    embeddable: Drawable;
+    freedraw: Drawable | null;
+    arrow: Drawable[];
+    line: Drawable[];
+    text: null;
+    image: null;
+    frame: null;
+    magicframe: null;
+};

package/types/excalidraw/scene/zoom.d.ts

@@ -1,12 +1,12 @@
-import type { AppState, NormalizedZoomValue } from "../types";
-export declare const getStateForZoom: ({ viewportX, viewportY, nextZoom, }: {
-    viewportX: number;
-    viewportY: number;
-    nextZoom: NormalizedZoomValue;
-}, appState: AppState) => {
-    scrollX: number;
-    scrollY: number;
-    zoom: {
-        value: NormalizedZoomValue;
-    };
-};
+import type { AppState, NormalizedZoomValue } from "../types";
+export declare const getStateForZoom: ({ viewportX, viewportY, nextZoom, }: {
+    viewportX: number;
+    viewportY: number;
+    nextZoom: NormalizedZoomValue;
+}, appState: AppState) => {
+    scrollX: number;
+    scrollY: number;
+    zoom: {
+        value: NormalizedZoomValue;
+    };
+};