@zsviczian/excalidraw 0.16.1-obsidian-8 → 0.17.0-obsidian-2

package/types/scene/export.d.ts

@@ -1,10 +1,10 @@
-import { NonDeletedExcalidrawElement } from "../element/types";
+import { ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "../element/types";
 import { AppState, BinaryFiles } from "../types";
-import { serializeAsJSON } from "../data/json";
-export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, }: {
+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;
@@ -16,9 +16,10 @@ export declare const exportToSvg: (elements: readonly NonDeletedExcalidrawElemen
     viewBackgroundColor: string;
     exportWithDarkMode?: boolean;
     exportEmbedScene?: boolean;
-    renderFrame?: boolean;
+    frameRendering?: AppState["frameRendering"];
+    frameColor?: AppState["frameColor"];
 }, files: BinaryFiles | null, opts?: {
-    serializeAsJSON?: () => string;
     renderEmbeddables?: boolean;
+    exportingFrame?: ExcalidrawFrameLikeElement | null;
 }) => Promise<SVGSVGElement>;
 export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];

package/types/scene/types.d.ts

@@ -82,6 +82,7 @@ export type ElementShapes = {
     rectangle: Drawable;
     ellipse: Drawable;
     diamond: Drawable;
+    iframe: Drawable;
     embeddable: Drawable;
     freedraw: Drawable | null;
     arrow: Drawable[];
@@ -89,4 +90,5 @@ export type ElementShapes = {
     text: null;
     image: null;
     frame: null;
+    magicframe: null;
 };

package/types/shapes.d.ts

@@ -59,4 +59,4 @@ export declare const SHAPES: readonly [{
     readonly numericKey: "0";
     readonly fillable: false;
 }];
-export declare const findShapeByKey: (key: string) => "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser" | null;
+export declare const findShapeByKey: (key: string) => "text" | "image" | "line" | "arrow" | "selection" | "rectangle" | "diamond" | "ellipse" | "freedraw" | "eraser" | null;

package/types/types.d.ts

@@ -1,11 +1,12 @@
 import React from "react";
-import { PointerType, ExcalidrawLinearElement, NonDeletedExcalidrawElement, NonDeleted, TextAlign, ExcalidrawElement, GroupId, ExcalidrawBindableElement, Arrowhead, ChartType, FontFamilyValues, ExcalidrawTextElement, FileId, ExcalidrawImageElement, Theme, StrokeRoundness, ExcalidrawFrameElement, ExcalidrawEmbeddableElement } from "./element/types";
+import { PointerType, ExcalidrawLinearElement, NonDeletedExcalidrawElement, NonDeleted, TextAlign, ExcalidrawElement, GroupId, ExcalidrawBindableElement, Arrowhead, ChartType, FontFamilyValues, ExcalidrawTextElement, FileId, ExcalidrawImageElement, Theme, StrokeRoundness, ExcalidrawEmbeddableElement, ExcalidrawMagicFrameElement, ExcalidrawFrameLikeElement, ExcalidrawElementType } from "./element/types";
+import { Action } from "./actions/types";
 import { Point as RoughPoint } from "roughjs/bin/geometry";
 import { LinearElementEditor } from "./element/linearElementEditor";
 import { SuggestedBinding } from "./element/binding";
 import { ImportedDataState } from "./data/types";
 import type App from "./components/App";
-import type { ResolvablePromise, throttleRAF } from "./utils";
+import type { throttleRAF } from "./utils";
 import { Spreadsheet } from "./charts";
 import { Language } from "./i18n";
 import { ClipboardData } from "./clipboard";
@@ -16,7 +17,7 @@ import type { FileSystemHandle } from "./data/filesystem";
 import type { IMAGE_MIME_TYPES, MIME_TYPES } from "./constants";
 import { ContextMenuItems } from "./components/ContextMenu";
 import { SnapLine } from "./snapping";
-import { Merge, ForwardRef, ValueOf } from "./utility-types";
+import { Merge, ValueOf } from "./utility-types";
 import { ColorPaletteCustom } from "./colors";
 export type Point = Readonly<RoughPoint>;
 export type Collaborator = {
@@ -59,7 +60,8 @@ export type BinaryFileData = {
 };
 export type BinaryFileMetadata = Omit<BinaryFileData, "dataURL">;
 export type BinaryFiles = Record<ExcalidrawElement["id"], BinaryFileData>;
-export type ToolType = "selection" | "rectangle" | "diamond" | "ellipse" | "arrow" | "line" | "freedraw" | "text" | "image" | "eraser" | "hand" | "frame" | "embeddable" | "laser" | "mermaid";
+export type ToolType = "selection" | "rectangle" | "diamond" | "ellipse" | "arrow" | "line" | "freedraw" | "text" | "image" | "eraser" | "hand" | "frame" | "magicframe" | "embeddable" | "laser" | "mermaid";
+export type ElementOrToolType = ExcalidrawElementType | ToolType | "custom";
 export type ActiveTool = {
     type: ToolType;
     customType: null;
@@ -107,13 +109,11 @@ export type InteractiveCanvasAppState = Readonly<_CommonCanvasAppState & {
     suggestedBindings: AppState["suggestedBindings"];
     isRotating: AppState["isRotating"];
     elementsToHighlight: AppState["elementsToHighlight"];
-    openSidebar: AppState["openSidebar"];
-    showHyperlinkPopup: AppState["showHyperlinkPopup"];
     collaborators: AppState["collaborators"];
     snapLines: AppState["snapLines"];
     zenModeEnabled: AppState["zenModeEnabled"];
 }>;
-export type AppState = {
+export interface AppState {
     contextMenu: {
         items: ContextMenuItems;
         top: number;
@@ -133,7 +133,7 @@ export type AppState = {
     isBindingEnabled: boolean;
     startBoundElement: NonDeleted<ExcalidrawBindableElement> | null;
     suggestedBindings: SuggestedBinding[];
-    frameToHighlight: NonDeleted<ExcalidrawFrameElement> | null;
+    frameToHighlight: NonDeleted<ExcalidrawFrameLikeElement> | null;
     frameRendering: {
         enabled: boolean;
         name: boolean;
@@ -186,7 +186,15 @@ export type AppState = {
         name: SidebarName;
         tab?: SidebarTabName;
     } | null;
-    openDialog: "imageExport" | "help" | "jsonExport" | "mermaid" | null;
+    openDialog: null | {
+        name: "imageExport" | "help" | "jsonExport";
+    } | {
+        name: "magicSettings";
+        source: "tool" | "generation" | "settings";
+    } | {
+        name: "ttd";
+        tab: string;
+    };
     /**
      * Reflects user preference for whether the default sidebar should be docked.
      *
@@ -268,6 +276,7 @@ export type AppState = {
     frameColor: {
         stroke: string;
         fill: string;
+        nameColor: string;
     };
     invertBindingBehaviour: boolean;
     selectedLinearElement: LinearElementEditor | null;
@@ -277,7 +286,7 @@ export type AppState = {
         y: number;
     } | null;
     objectsSnapModeEnabled: boolean;
-};
+}
 export type UIAppState = Omit<AppState, "suggestedBindings" | "startBoundElement" | "cursorButton" | "scrollX" | "scrollY">;
 export type NormalizedZoomValue = number & {
     _brand: "normalizedZoom";
@@ -319,17 +328,13 @@ export type LibraryItem = {
 export type LibraryItems = readonly LibraryItem[];
 export type LibraryItems_anyVersion = LibraryItems | LibraryItems_v1;
 export type LibraryItemsSource = ((currentLibraryItems: LibraryItems) => Blob | LibraryItems_anyVersion | Promise<LibraryItems_anyVersion | Blob>) | Blob | LibraryItems_anyVersion | Promise<LibraryItems_anyVersion | Blob>;
-export type ExcalidrawAPIRefValue = ExcalidrawImperativeAPI | {
-    readyPromise?: ResolvablePromise<ExcalidrawImperativeAPI>;
-    ready?: false;
-};
 export type ExcalidrawInitialDataState = Merge<ImportedDataState, {
     libraryItems?: Required<ImportedDataState>["libraryItems"] | Promise<Required<ImportedDataState>["libraryItems"]>;
 }>;
 export interface ExcalidrawProps {
     onChange?: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => void;
     initialData?: ExcalidrawInitialDataState | null | Promise<ExcalidrawInitialDataState | null>;
-    excalidrawRef?: ForwardRef<ExcalidrawAPIRefValue>;
+    excalidrawAPI?: (api: ExcalidrawImperativeAPI) => void;
     isCollaborating?: boolean;
     onPointerUpdate?: (payload: {
         pointer: {
@@ -375,6 +380,8 @@ export interface ExcalidrawProps {
     renderWebview?: boolean;
     renderEmbeddableMenu?: (appState: AppState) => JSX.Element | null;
     renderMermaid?: boolean;
+    onContextMenu?: (element: readonly NonDeletedExcalidrawElement[], appState: AppState, onClose: (callback?: () => void) => void) => JSX.Element | null;
+    aiEnabled?: boolean;
 }
 export type SceneData = {
     elements?: ImportedDataState["elements"];
@@ -392,7 +399,7 @@ export type ExportOpts = {
     onExportToBackend?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement) => void;
     renderCustomUI?: (exportedElements: readonly NonDeletedExcalidrawElement[], appState: UIAppState, files: BinaryFiles, canvas: HTMLCanvasElement) => JSX.Element;
 };
-type CanvasActions = Partial<{
+export type CanvasActions = Partial<{
     changeViewBackgroundColor: boolean;
     clearCanvas: boolean;
     export: false | ExportOpts;
@@ -401,9 +408,12 @@ type CanvasActions = Partial<{
     toggleTheme: boolean | null;
     saveAsImage: boolean;
 }>;
-type UIOptions = Partial<{
+export type UIOptions = Partial<{
     dockedSidebarBreakpoint: number;
     canvasActions: CanvasActions;
+    tools: {
+        image: boolean;
+    };
     /** @deprecated does nothing. Will be removed in 0.15 */
     welcomeScreen?: boolean;
 }>;
@@ -417,6 +427,7 @@ export type AppProps = Merge<ExcalidrawProps, {
     handleKeyboardGlobally: boolean;
     isCollaborating: boolean;
     children?: React.ReactNode;
+    aiEnabled: boolean;
 }>;
 /** A subset of App class properties that we need to use elsewhere
  * in the app, eg Manager. Factored out into a separate type to keep DRY. */
@@ -446,6 +457,8 @@ export type AppClassProperties = {
     togglePenMode: App["togglePenMode"];
     setActiveTool: App["setActiveTool"];
     setOpenDialog: App["setOpenDialog"];
+    insertEmbeddableElement: App["insertEmbeddableElement"];
+    onMagicframeToolSelect: App["onMagicframeToolSelect"];
 };
 export type PointerDownState = Readonly<{
     origin: Readonly<{
@@ -521,12 +534,11 @@ export type ExcalidrawImperativeAPI = {
     getSceneElements: InstanceType<typeof App>["getSceneElements"];
     getAppState: () => InstanceType<typeof App>["state"];
     getFiles: () => InstanceType<typeof App>["files"];
+    registerAction: (action: Action) => void;
     refresh: InstanceType<typeof App>["refresh"];
     setToast: InstanceType<typeof App>["setToast"];
     addFiles: (data: BinaryFileData[]) => void;
     updateContainerSize: InstanceType<typeof App>["updateContainerSize"];
-    readyPromise: ResolvablePromise<ExcalidrawImperativeAPI>;
-    ready: true;
     id: string;
     setLocalFont: (showOnPanel: boolean) => void;
     selectElements: (elements: readonly ExcalidrawElement[]) => void;
@@ -551,11 +563,15 @@ export type ExcalidrawImperativeAPI = {
     onPointerUp: (callback: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState, event: PointerEvent) => void) => UnsubscribeCallback;
 };
 export type Device = Readonly<{
-    isSmScreen: boolean;
-    isMobile: boolean;
+    viewport: {
+        isMobile: boolean;
+        isLandscape: boolean;
+    };
+    editor: {
+        isMobile: boolean;
+        canFitSidebar: boolean;
+    };
     isTouchScreen: boolean;
-    canDeviceFitSidebar: boolean;
-    isLandscape: boolean;
 }>;
 type FrameNameBounds = {
     x: number;
@@ -565,10 +581,10 @@ type FrameNameBounds = {
     angle: number;
 };
 export type FrameNameBoundsCache = {
-    get: (frameElement: ExcalidrawFrameElement) => FrameNameBounds | null;
+    get: (frameElement: ExcalidrawFrameLikeElement | ExcalidrawMagicFrameElement) => FrameNameBounds | null;
     _cache: Map<string, FrameNameBounds & {
         zoom: AppState["zoom"]["value"];
-        versionNonce: ExcalidrawFrameElement["versionNonce"];
+        versionNonce: ExcalidrawFrameLikeElement["versionNonce"];
     }>;
 };
 export type KeyboardModifiersObject = {
@@ -578,4 +594,5 @@ export type KeyboardModifiersObject = {
     metaKey: boolean;
 };
 export type Primitive = number | string | boolean | bigint | symbol | null | undefined;
+export type JSONValue = string | number | boolean | null | object;
 export {};

package/types/utils.d.ts

@@ -1,5 +1,5 @@
 import { EVENT } from "./constants";
-import { FontFamilyValues, FontString, NonDeletedExcalidrawElement } from "./element/types";
+import { FontFamilyValues, FontString } from "./element/types";
 import { ActiveTool, AppState, ToolType, Zoom } from "./types";
 export declare const setDateTimeForTests: (dateTime: string) => void;
 export declare const getDateTime: () => string;
@@ -186,8 +186,11 @@ export declare const isShallowEqual: <T extends Record<string, any>, I extends k
 export declare const composeEventHandlers: <E>(originalEventHandler?: ((event: E) => void) | undefined, ourEventHandler?: ((event: E) => void) | undefined, { checkForDefaultPrevented }?: {
     checkForDefaultPrevented?: boolean | undefined;
 }) => (event: E) => void;
-export declare const isOnlyExportingSingleFrame: (elements: readonly NonDeletedExcalidrawElement[]) => boolean;
-export declare const assertNever: (value: never, message: string, softAssert?: boolean) => never;
+/**
+ * supply `null` as message if non-never value is valid, you just need to
+ * typecheck against it
+ */
+export declare const assertNever: (value: never, message: string | null, softAssert?: boolean) => never;
 /**
  * Memoizes on values of `opts` object (strict equality).
  */
@@ -197,3 +200,5 @@ export declare const memoize: <T extends Record<string, any>, R extends unknown>
 export declare const isRenderThrottlingEnabled: () => boolean;
 /** Checks if value is inside given collection. Useful for type-safety. */
 export declare const isMemberOf: <T extends string>(collection: Set<T> | Record<T, any> | Map<T, any> | readonly T[], value: string) => value is T;
+export declare const cloneJSON: <T>(obj: T) => T;
+export declare const isFiniteNumber: (value: any) => value is number;