@zsviczian/excalidraw 0.14.2-obsidian-5 → 0.15.2-obsidian-2

package/types/renderer/renderElement.d.ts

@@ -9,6 +9,7 @@ export interface ExcalidrawElementWithCanvas {
     canvas: HTMLCanvasElement;
     theme: RenderConfig["theme"];
     scale: number;
+    zoomValue: RenderConfig["zoom"]["value"];
     canvasOffsetX: number;
     canvasOffsetY: number;
     boundTextElementVersion: number | null;

package/types/scene/export.d.ts

@@ -1,5 +1,6 @@
 import { NonDeletedExcalidrawElement } from "../element/types";
 import { AppState, BinaryFiles } from "../types";
+import { serializeAsJSON } from "../data/json";
 export declare const SVG_EXPORT_TAG = "<!-- svg-source:excalidraw -->";
 export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, }: {
     exportBackground: boolean;
@@ -16,5 +17,7 @@ export declare const exportToSvg: (elements: readonly NonDeletedExcalidrawElemen
     viewBackgroundColor: string;
     exportWithDarkMode?: boolean;
     exportEmbedScene?: boolean;
-}, files: BinaryFiles | null) => Promise<SVGSVGElement>;
+}, files: BinaryFiles | null, opts?: {
+    serializeAsJSON?: () => string;
+}) => Promise<SVGSVGElement>;
 export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];

package/types/scene/selection.d.ts

@@ -1,11 +1,11 @@
 import { ExcalidrawElement, NonDeletedExcalidrawElement } from "../element/types";
 import { AppState } from "../types";
 export declare const getElementsWithinSelection: (elements: readonly NonDeletedExcalidrawElement[], selection: NonDeletedExcalidrawElement) => NonDeletedExcalidrawElement[];
-export declare const isSomeElementSelected: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState) => boolean;
+export declare const isSomeElementSelected: (elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">) => boolean;
 /**
  * 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: AppState, getAttribute: (element: ExcalidrawElement) => T) => T | null;
-export declare const getSelectedElements: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, includeBoundTextElement?: boolean) => NonDeletedExcalidrawElement[];
-export declare const getTargetElements: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState) => NonDeletedExcalidrawElement[];
+export declare const getCommonAttributeOfSelectedElements: <T>(elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">, getAttribute: (element: ExcalidrawElement) => T) => T | null;
+export declare const getSelectedElements: (elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds">, includeBoundTextElement?: boolean) => NonDeletedExcalidrawElement[];
+export declare const getTargetElements: (elements: readonly NonDeletedExcalidrawElement[], appState: Pick<AppState, "selectedElementIds" | "editingElement">) => NonDeletedExcalidrawElement[];

package/types/types.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 import { PointerType, ExcalidrawLinearElement, NonDeletedExcalidrawElement, NonDeleted, TextAlign, ExcalidrawElement, GroupId, ExcalidrawBindableElement, Arrowhead, ChartType, FontFamilyValues, ExcalidrawTextElement, FileId, ExcalidrawImageElement, Theme, StrokeRoundness } from "./element/types";
 import { SHAPES } from "./shapes";
 import { Point as RoughPoint } from "roughjs/bin/geometry";
@@ -13,10 +14,9 @@ import { isOverScrollBars } from "./scene";
 import { MaybeTransformHandleType } from "./element/transformHandles";
 import Library from "./data/library";
 import type { FileSystemHandle } from "./data/filesystem";
-import type { ALLOWED_IMAGE_MIME_TYPES, MIME_TYPES } from "./constants";
+import type { IMAGE_MIME_TYPES, MIME_TYPES } from "./constants";
 import { ContextMenuItems } from "./components/ContextMenu";
-import { Merge, ForwardRef } from "./utility-types";
-import React from "react";
+import { Merge, ForwardRef, ValueOf } from "./utility-types";
 export declare type Point = Readonly<RoughPoint>;
 export declare type Collaborator = {
     pointer?: {
@@ -38,7 +38,7 @@ export declare type DataURL = string & {
     _brand: "DataURL";
 };
 export declare type BinaryFileData = {
-    mimeType: typeof ALLOWED_IMAGE_MIME_TYPES[number] | typeof MIME_TYPES.binary;
+    mimeType: ValueOf<typeof IMAGE_MIME_TYPES> | typeof MIME_TYPES.binary;
     id: FileId;
     dataURL: DataURL;
     /**
@@ -63,6 +63,8 @@ export declare type LastActiveTool = {
     type: "custom";
     customType: string;
 } | null;
+export declare type SidebarName = string;
+export declare type SidebarTabName = string;
 export declare type AppState = {
     contextMenu: {
         items: ContextMenuItems;
@@ -125,9 +127,19 @@ export declare type AppState = {
     zoom: Zoom;
     openMenu: "canvas" | "shape" | null;
     openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-    openSidebar: "library" | "customSidebar" | null;
+    openSidebar: {
+        name: SidebarName;
+        tab?: SidebarTabName;
+    } | null;
     openDialog: "imageExport" | "help" | "jsonExport" | null;
-    isSidebarDocked: boolean;
+    /**
+     * Reflects user preference for whether the default sidebar should be docked.
+     *
+     * NOTE this is only a user preference and does not reflect the actual docked
+     * state of the sidebar, because the host apps can override this through
+     * a DefaultSidebar prop, which is not reflected back to the appState.
+     */
+    defaultSidebarDockedPreference: boolean;
     lastPointerDownWith: PointerType;
     selectedElementIds: {
         [id: string]: boolean;
@@ -186,8 +198,10 @@ export declare type AppState = {
     resetCustomPen?: any;
     gridColor: string;
     dynamicStyle: string;
+    invertBindingBehaviour: boolean;
     selectedLinearElement: LinearElementEditor | null;
 };
+export declare type UIAppState = Omit<AppState, "suggestedBindings" | "startBoundElement" | "cursorButton" | "scrollX" | "scrollY">;
 export declare type NormalizedZoomValue = number & {
     _brand: "normalizedZoom";
 };
@@ -250,7 +264,7 @@ export interface ExcalidrawProps {
     }) => void;
     onPaste?: (data: ClipboardData, event: ClipboardEvent | null) => Promise<boolean> | boolean;
     onDrop?: (event: React.DragEvent<HTMLDivElement>) => Promise<boolean> | boolean;
-    renderTopRightUI?: (isMobile: boolean, appState: AppState) => JSX.Element | null;
+    renderTopRightUI?: (isMobile: boolean, appState: UIAppState) => JSX.Element | null;
     langCode?: Language["code"];
     viewModeEnabled?: boolean;
     zenModeEnabled?: boolean;
@@ -259,7 +273,7 @@ export interface ExcalidrawProps {
     initState?: AppState;
     theme?: Theme;
     name?: string;
-    renderCustomStats?: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState) => JSX.Element;
+    renderCustomStats?: (elements: readonly NonDeletedExcalidrawElement[], appState: UIAppState) => JSX.Element;
     UIOptions?: Partial<UIOptions>;
     detectScroll?: boolean;
     handleKeyboardGlobally?: boolean;
@@ -276,10 +290,6 @@ export interface ExcalidrawProps {
     onLinkHover?: (element: NonDeletedExcalidrawElement, event: React.PointerEvent<HTMLCanvasElement>) => void;
     onPointerDown?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
     onScrollChange?: (scrollX: number, scrollY: number) => void;
-    /**
-     * Render function that renders custom <Sidebar /> component.
-     */
-    renderSidebar?: () => JSX.Element | null;
     children?: React.ReactNode;
 }
 export declare type SceneData = {
@@ -295,8 +305,8 @@ export declare enum UserIdleState {
 }
 export declare type ExportOpts = {
     saveFileToDisk?: boolean;
-    onExportToBackend?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, canvas: HTMLCanvasElement | null) => void;
-    renderCustomUI?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, canvas: HTMLCanvasElement | null) => JSX.Element;
+    onExportToBackend?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement | null) => void;
+    renderCustomUI?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement | null) => JSX.Element;
 };
 declare type CanvasActions = Partial<{
     changeViewBackgroundColor: boolean;
@@ -333,12 +343,14 @@ export declare type AppClassProperties = {
     library: Library;
     imageCache: Map<FileId, {
         image: HTMLImageElement | Promise<HTMLImageElement>;
-        mimeType: typeof ALLOWED_IMAGE_MIME_TYPES[number];
+        mimeType: ValueOf<typeof IMAGE_MIME_TYPES>;
     }>;
     files: BinaryFiles;
     device: App["device"];
     scene: App["scene"];
     pasteFromClipboard: App["pasteFromClipboard"];
+    id: App["id"];
+    onInsertElements: App["onInsertElements"];
 };
 export declare type PointerDownState = Readonly<{
     origin: Readonly<{
@@ -431,7 +443,7 @@ export declare type ExcalidrawImperativeAPI = {
     setActiveTool: InstanceType<typeof App>["setActiveTool"];
     setCursor: InstanceType<typeof App>["setCursor"];
     resetCursor: InstanceType<typeof App>["resetCursor"];
-    toggleMenu: InstanceType<typeof App>["toggleMenu"];
+    toggleSidebar: InstanceType<typeof App>["toggleSidebar"];
 };
 export declare type Device = Readonly<{
     isSmScreen: boolean;

package/types/utils.d.ts

@@ -63,7 +63,7 @@ export declare const updateActiveTool: (appState: Pick<AppState, "activeTool">,
 export declare const resetCursor: (canvas: HTMLCanvasElement | null) => void;
 export declare const setCursor: (canvas: HTMLCanvasElement | null, cursor: string) => void;
 export declare const setEraserCursor: (canvas: HTMLCanvasElement | null, theme: AppState["theme"]) => void;
-export declare const setCursorForShape: (canvas: HTMLCanvasElement | null, appState: AppState) => void;
+export declare const setCursorForShape: (canvas: HTMLCanvasElement | null, appState: Pick<AppState, "activeTool" | "theme">) => void;
 export declare const isFullScreen: () => boolean;
 export declare const allowFullScreen: () => Promise<void>;
 export declare const exitFullScreen: () => Promise<void>;
@@ -156,7 +156,7 @@ export declare const isPrimitive: (val: any) => boolean;
 export declare const getFrame: () => "top" | "iframe";
 export declare const isPromiseLike: (value: any) => value is Promise<any>;
 export declare const queryFocusableElements: (container: HTMLElement | null) => HTMLElement[];
-export declare const isShallowEqual: <T extends Record<string, any>>(objA: T, objB: T) => boolean;
+export declare const isShallowEqual: <T extends Record<string, any>, I extends keyof T>(objA: T, objB: T, comparators?: Record<I, (a: T[I], b: T[I]) => boolean> | undefined, debug?: boolean) => boolean;
 export declare const composeEventHandlers: <E>(originalEventHandler?: ((event: E) => void) | undefined, ourEventHandler?: ((event: E) => void) | undefined, { checkForDefaultPrevented }?: {
     checkForDefaultPrevented?: boolean | undefined;
 }) => (event: E) => void;