@zsviczian/excalidraw 0.16.1-obsidian-7 → 0.17.0-obsidian-1

package/types/packages/excalidraw/webpack.preact.config.d.ts

@@ -0,0 +1,170 @@
+declare const _exports: {
+    mode: string;
+    entry: {
+        "excalidraw.development": string;
+    };
+    output: {
+        path: string;
+        library: string;
+        libraryTarget: string;
+        filename: string;
+        chunkFilename: string;
+        assetModuleFilename: string;
+        publicPath: string;
+    };
+    resolve: {
+        extensions: string[];
+    };
+    module: {
+        rules: ({
+            test: RegExp;
+            exclude: RegExp;
+            use: (string | {
+                loader: string;
+            } | {
+                loader: string;
+                options: {
+                    postcssOptions: {
+                        plugins: (import("postcss").Plugin & import("autoprefixer").ExportedAPI)[];
+                    };
+                };
+            })[];
+        } | {
+            test: RegExp;
+            resolve: {
+                fullySpecified: boolean;
+            };
+        } | {
+            test: RegExp;
+            exclude: RegExp;
+            use: ({
+                loader: string;
+            } | {
+                loader: string;
+                options: {
+                    transpileOnly: boolean;
+                    configFile: string;
+                };
+            })[];
+        } | {
+            test: RegExp;
+            type: string;
+        })[];
+    };
+    optimization: {
+        splitChunks: {
+            chunks: string;
+            cacheGroups: {
+                vendors: {
+                    test: RegExp;
+                    name: string;
+                };
+            };
+        };
+    };
+    plugins: any[];
+    externals: {
+        react: {
+            root: string;
+            commonjs2: string;
+            commonjs: string;
+            amd: string;
+        };
+        "react-dom": {
+            root: string;
+            commonjs2: string;
+            commonjs: string;
+            amd: string;
+        };
+    };
+} | {
+    mode: string;
+    entry: {
+        "excalidraw.production.min": string;
+    };
+    output: {
+        path: string;
+        library: string;
+        libraryTarget: string;
+        filename: string;
+        chunkFilename: string;
+        assetModuleFilename: string;
+        publicPath: string;
+    };
+    resolve: {
+        extensions: string[];
+    };
+    module: {
+        rules: ({
+            test: RegExp;
+            exclude: RegExp;
+            use: (string | {
+                loader: string;
+            } | {
+                loader: string;
+                options: {
+                    postcssOptions: {
+                        plugins: (import("postcss").Plugin & import("autoprefixer").ExportedAPI)[];
+                    };
+                };
+            })[];
+        } | {
+            test: RegExp;
+            resolve: {
+                fullySpecified: boolean;
+            };
+        } | {
+            test: RegExp;
+            exclude: RegExp;
+            use: ({
+                loader: string;
+            } | {
+                loader: string;
+                options: {
+                    transpileOnly: boolean;
+                    configFile: string;
+                };
+            } | {
+                loader: string;
+                options: {
+                    presets: (string | (string | {
+                        runtime: string;
+                    })[])[];
+                    plugins: string[];
+                };
+            })[];
+        } | {
+            test: RegExp;
+            type: string;
+        })[];
+    };
+    optimization: {
+        minimize: boolean;
+        minimizer: import("terser-webpack-plugin")<import("terser").MinifyOptions>[];
+        splitChunks: {
+            chunks: string;
+            cacheGroups: {
+                vendors: {
+                    test: RegExp;
+                    name: string;
+                };
+            };
+        };
+    };
+    plugins: any[];
+    externals: {
+        react: {
+            root: string;
+            commonjs2: string;
+            commonjs: string;
+            amd: string;
+        };
+        "react-dom": {
+            root: string;
+            commonjs2: string;
+            commonjs: string;
+            amd: string;
+        };
+    };
+};
+export = _exports;

package/types/packages/utils.d.ts

@@ -1,5 +1,5 @@
 import { AppState, BinaryFiles } from "../types";
-import { ExcalidrawElement, NonDeleted } from "../element/types";
+import { ExcalidrawElement, ExcalidrawFrameElement, NonDeleted } from "../element/types";
 import { MIME_TYPES } from "../constants";
 export { MIME_TYPES };
 type ExportOpts = {
@@ -7,13 +7,14 @@ type ExportOpts = {
     appState?: Partial<Omit<AppState, "offsetTop" | "offsetLeft">>;
     files: BinaryFiles | null;
     maxWidthOrHeight?: number;
+    exportingFrame?: ExcalidrawFrameElement | null;
     getDimensions?: (width: number, height: number) => {
         width: number;
         height: number;
         scale?: number;
     };
 };
-export declare const exportToCanvas: ({ elements, appState, files, maxWidthOrHeight, getDimensions, exportPadding, }: ExportOpts & {
+export declare const exportToCanvas: ({ elements, appState, files, maxWidthOrHeight, getDimensions, exportPadding, exportingFrame, }: ExportOpts & {
     exportPadding?: number | undefined;
 }) => Promise<HTMLCanvasElement>;
 export declare const exportToBlob: (opts: ExportOpts & {
@@ -21,7 +22,7 @@ export declare const exportToBlob: (opts: ExportOpts & {
     quality?: number;
     exportPadding?: number;
 }) => Promise<Blob>;
-export declare const exportToSvg: ({ elements, appState, files, exportPadding, renderEmbeddables, }: Omit<ExportOpts, "getDimensions"> & {
+export declare const exportToSvg: ({ elements, appState, files, exportPadding, renderEmbeddables, exportingFrame, }: Omit<ExportOpts, "getDimensions"> & {
     exportPadding?: number | undefined;
     renderEmbeddables?: boolean | undefined;
 }) => Promise<SVGSVGElement>;
@@ -30,6 +31,8 @@ export declare const exportToClipboard: (opts: ExportOpts & {
     quality?: number;
     type: "png" | "svg" | "json";
 }) => Promise<void>;
+export * from "./bbox";
+export { elementsOverlappingBBox, isElementInsideBBox, elementPartiallyOverlapsWithOrContainsBBox, } from "./withinBounds";
 export { serializeAsJSON, serializeLibraryAsJSON } from "../data/json";
 export { loadFromBlob, loadSceneOrLibraryFromBlob, loadLibraryFromBlob, } from "../data/blob";
 export { getFreeDrawSvgPath } from "../renderer/renderElement";

package/types/packages/withinBounds.d.ts

@@ -0,0 +1,19 @@
+import type { ExcalidrawElement, NonDeletedExcalidrawElement } from "../element/types";
+import { Bounds } from "../element/bounds";
+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 | undefined;
+    /**
+     * - overlap: elements overlapping or inside bounds
+     * - contain: elements inside bounds or bounds inside elements
+     * - inside: elements inside bounds
+     **/
+    type: "overlap" | "contain" | "inside";
+}) => NonDeletedExcalidrawElement[];
+export {};

package/types/renderer/renderElement.d.ts

@@ -18,7 +18,12 @@ export declare const DEFAULT_LINK_SIZE = 14;
 export declare const elementWithCanvasCache: WeakMap<ExcalidrawElement, ExcalidrawElementWithCanvas>;
 export declare const renderSelectionElement: (element: NonDeletedExcalidrawElement, context: CanvasRenderingContext2D, appState: InteractiveCanvasAppState) => void;
 export declare const renderElement: (element: NonDeletedExcalidrawElement, rc: RoughCanvas, context: CanvasRenderingContext2D, renderConfig: StaticCanvasRenderConfig, appState: StaticCanvasAppState) => void;
-export declare const renderElementToSvg: (element: NonDeletedExcalidrawElement, rsvg: RoughSVG, svgRoot: SVGElement, files: BinaryFiles, offsetX: number, offsetY: number, exportWithDarkMode?: boolean, exportingFrameId?: string | null, renderEmbeddables?: boolean) => void;
+export declare const renderElementToSvg: (element: NonDeletedExcalidrawElement, rsvg: RoughSVG, svgRoot: SVGElement, files: BinaryFiles, offsetX: number, offsetY: number, renderConfig: {
+    exportWithDarkMode: boolean;
+    renderEmbeddables: boolean;
+    frameRendering: AppState["frameRendering"];
+    frameColor?: AppState["frameColor"];
+}) => void;
 export declare const pathsCache: WeakMap<ExcalidrawFreeDrawElement, Path2D>;
 export declare function generateFreeDrawShape(element: ExcalidrawFreeDrawElement): Path2D;
 export declare function getFreeDrawPath2D(element: ExcalidrawFreeDrawElement): Path2D | undefined;

package/types/renderer/renderScene.d.ts

@@ -1,5 +1,5 @@
 import { RoughSVG } from "roughjs/bin/svg";
-import { BinaryFiles } from "../types";
+import { BinaryFiles, AppState } from "../types";
 import { NonDeletedExcalidrawElement } from "../element/types";
 import { InteractiveSceneRenderConfig, StaticSceneRenderConfig } from "../scene/types";
 import "canvas-roundrect-polyfill";
@@ -22,10 +22,15 @@ export declare const renderInteractiveScene: <U extends ({ canvas, elements, vis
  */
 export declare const renderStaticScene: (renderConfig: StaticSceneRenderConfig, throttle?: boolean) => void;
 export declare const cancelRender: () => void;
-export declare const renderSceneToSvg: (elements: readonly NonDeletedExcalidrawElement[], rsvg: RoughSVG, svgRoot: SVGElement, files: BinaryFiles, { offsetX, offsetY, exportWithDarkMode, exportingFrameId, renderEmbeddables, }?: {
+export declare const renderSceneToSvg: (elements: readonly NonDeletedExcalidrawElement[], rsvg: RoughSVG, svgRoot: SVGElement, files: BinaryFiles, { offsetX, offsetY, exportWithDarkMode, renderEmbeddables, frameRendering, frameColor, }: {
     offsetX?: number | undefined;
     offsetY?: number | undefined;
-    exportWithDarkMode?: boolean | undefined;
-    exportingFrameId?: string | null | undefined;
-    renderEmbeddables?: boolean | undefined;
+    exportWithDarkMode: boolean;
+    renderEmbeddables: boolean;
+    frameRendering: AppState["frameRendering"];
+    frameColor?: {
+        stroke: string;
+        fill: string;
+        nameColor: string;
+    } | undefined;
 }) => void;

package/types/scene/Scene.d.ts

@@ -9,7 +9,12 @@ export type ExcalidrawElementsIncludingDeleted = readonly ExcalidrawElement[];
 declare class Scene {
     private static sceneMapByElement;
     private static sceneMapById;
-    static mapElementToScene(elementKey: ElementKey, scene: Scene): void;
+    static mapElementToScene(elementKey: ElementKey, scene: Scene, 
+    /**
+     * needed because of frame exporting hack.
+     * elementId:Scene mapping will be removed completely, soon.
+     */
+    mapElementIds?: boolean): void;
     static getScene(elementKey: ElementKey): Scene | null;
     private callbacks;
     private nonDeletedElements;
@@ -50,7 +55,7 @@ declare class Scene {
      * @returns whether a change was made
      */
     mapElements(iteratee: (element: ExcalidrawElement) => ExcalidrawElement): boolean;
-    replaceAllElements(nextElements: readonly ExcalidrawElement[]): void;
+    replaceAllElements(nextElements: readonly ExcalidrawElement[], mapElementIds?: boolean): void;
     informMutation(): void;
     addCallback(cb: SceneStateCallback): SceneStateCallbackRemover;
     destroy(): void;

package/types/scene/export.d.ts

@@ -1,11 +1,10 @@
-import { NonDeletedExcalidrawElement } from "../element/types";
+import { ExcalidrawFrameElement, 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, }: {
+export declare const exportToCanvas: (elements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, exportingFrame, }: {
     exportBackground: boolean;
     exportPadding?: number | undefined;
     viewBackgroundColor: string;
+    exportingFrame?: ExcalidrawFrameElement | null | undefined;
 }, createCanvas?: (width: number, height: number) => {
     canvas: HTMLCanvasElement;
     scale: number;
@@ -17,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?: ExcalidrawFrameElement | null;
 }) => Promise<SVGSVGElement>;
 export declare const getExportSize: (elements: readonly NonDeletedExcalidrawElement[], exportPadding: number, scale: number) => [number, number];

package/types/types.d.ts

@@ -5,7 +5,7 @@ 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 +16,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 = {
@@ -94,6 +94,7 @@ export type StaticCanvasAppState = Readonly<_CommonCanvasAppState & {
     frameRendering: AppState["frameRendering"];
     linkOpacity: AppState["linkOpacity"];
     gridColor: AppState["gridColor"];
+    frameColor: AppState["frameColor"];
 }>;
 export type InteractiveCanvasAppState = Readonly<_CommonCanvasAppState & {
     activeEmbeddable: AppState["activeEmbeddable"];
@@ -185,7 +186,7 @@ export type AppState = {
         name: SidebarName;
         tab?: SidebarTabName;
     } | null;
-    openDialog: "imageExport" | "help" | "jsonExport" | null;
+    openDialog: "imageExport" | "help" | "jsonExport" | "mermaid" | null;
     /**
      * Reflects user preference for whether the default sidebar should be docked.
      *
@@ -261,7 +262,14 @@ export type AppState = {
         Regular: string;
         MajorGridFrequency?: number;
     };
-    dynamicStyle: string;
+    dynamicStyle: {
+        [x: string]: string;
+    };
+    frameColor: {
+        stroke: string;
+        fill: string;
+        nameColor: string;
+    };
     invertBindingBehaviour: boolean;
     selectedLinearElement: LinearElementEditor | null;
     snapLines: readonly SnapLine[];
@@ -312,17 +320,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: {
@@ -368,6 +372,7 @@ 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;
 }
 export type SceneData = {
     elements?: ImportedDataState["elements"];
@@ -385,7 +390,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;
@@ -394,9 +399,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;
 }>;
@@ -434,10 +442,11 @@ export type AppClassProperties = {
     lastViewportPosition: App["lastViewportPosition"];
     scrollToContent: App["scrollToContent"];
     addFiles: App["addFiles"];
-    setSelection: App["setSelection"];
     addElementsFromPasteOrLibrary: App["addElementsFromPasteOrLibrary"];
+    setSelection: App["setSelection"];
     togglePenMode: App["togglePenMode"];
     setActiveTool: App["setActiveTool"];
+    setOpenDialog: App["setOpenDialog"];
 };
 export type PointerDownState = Readonly<{
     origin: Readonly<{
@@ -517,8 +526,6 @@ export type ExcalidrawImperativeAPI = {
     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;
@@ -543,11 +550,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;

package/types/utils.d.ts

@@ -187,7 +187,11 @@ export declare const composeEventHandlers: <E>(originalEventHandler?: ((event: E
     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).
  */
@@ -195,3 +199,6 @@ export declare const memoize: <T extends Record<string, any>, R extends unknown>
     clear: () => void;
 };
 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;

package/types/zindex.d.ts

@@ -1,6 +1,6 @@
 import { ExcalidrawElement } from "./element/types";
 import { AppState } from "./types";
-export declare const moveOneLeft: (elements: readonly ExcalidrawElement[], appState: AppState, elementsToBeMoved?: readonly ExcalidrawElement[]) => ExcalidrawElement[];
-export declare const moveOneRight: (elements: readonly ExcalidrawElement[], appState: AppState, elementsToBeMoved?: readonly ExcalidrawElement[]) => ExcalidrawElement[];
-export declare const moveAllLeft: (elements: readonly ExcalidrawElement[], appState: AppState, elementsToBeMoved?: readonly ExcalidrawElement[]) => ExcalidrawElement[];
-export declare const moveAllRight: (elements: readonly ExcalidrawElement[], appState: AppState, elementsToBeMoved?: readonly ExcalidrawElement[]) => ExcalidrawElement[];
+export declare const moveOneLeft: (allElements: readonly ExcalidrawElement[], appState: AppState) => ExcalidrawElement[];
+export declare const moveOneRight: (allElements: readonly ExcalidrawElement[], appState: AppState) => ExcalidrawElement[];
+export declare const moveAllLeft: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[] | ExcalidrawElement[];
+export declare const moveAllRight: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[] | ExcalidrawElement[];