@excalidraw/excalidraw 0.12.0-4cb6f09 → 0.12.0-4cd2525

package/types/components/Sidebar/Sidebar.d.ts

@@ -0,0 +1,73 @@
+/// <reference types="react" />
+import "./Sidebar.scss";
+/** using a counter instead of boolean to handle race conditions where
+ * the host app may render (mount/unmount) multiple different sidebar */
+export declare const hostSidebarCountersAtom: import("jotai").Atom<{
+    rendered: number;
+    docked: number;
+}> & {
+    write: (get: {
+        <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
+        <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
+        <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? any : V : V : V : V : V : V : V : V : V : V : Value_2;
+    } & {
+        <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
+            unstable_promise: true;
+        }): Value_3 | Promise<Value_3>;
+        <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
+            unstable_promise: true;
+        }): Value_4 | Promise<Value_4>;
+        <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
+            unstable_promise: true;
+        }): (Value_5 extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? any : V : V : V : V : V : V : V : V : V : V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? V extends Promise<infer V> ? any : V : V : V : V : V : V : V : V : V : V : Value_5>;
+    }, set: {
+        <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
+        <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
+    }, update: {
+        rendered: number;
+        docked: number;
+    } | ((prev: {
+        rendered: number;
+        docked: number;
+    }) => {
+        rendered: number;
+        docked: number;
+    })) => void;
+    onMount?: (<S extends (update: {
+        rendered: number;
+        docked: number;
+    } | ((prev: {
+        rendered: number;
+        docked: number;
+    }) => {
+        rendered: number;
+        docked: number;
+    })) => void>(setAtom: S) => void | (() => void)) | undefined;
+} & {
+    /** @private internal */
+    init: {
+        rendered: number;
+        docked: number;
+    };
+};
+export declare const Sidebar: import("react").ForwardRefExoticComponent<{
+    children: import("react").ReactNode;
+    onClose?: (() => boolean | void) | undefined;
+    onDock?: ((docked: boolean) => void) | undefined;
+    docked?: boolean | undefined;
+    dockable?: boolean | undefined;
+    className?: string | undefined;
+} & {
+    /** @private internal */
+    __isInternal?: boolean | undefined;
+} & import("react").RefAttributes<HTMLDivElement>> & {
+    Header: {
+        (props: {
+            children?: import("react").ReactNode;
+            className?: string | undefined;
+        } & {
+            __isFallback?: boolean | undefined;
+        }): JSX.Element | null;
+        displayName: string;
+    };
+};

package/types/components/Sidebar/SidebarHeader.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+export declare const SidebarDockButton: (props: {
+    checked: boolean;
+    onChange?(): void;
+}) => JSX.Element;
+/** @private */
+export declare const SidebarHeaderComponents: {
+    Context: import("react").FC<{
+        children: import("react").ReactNode;
+    }>;
+    Component: {
+        (props: {
+            children?: React.ReactNode;
+            className?: string | undefined;
+        } & {
+            __isFallback?: boolean | undefined;
+        }): JSX.Element | null;
+        displayName: string;
+    };
+};

package/types/components/Sidebar/common.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+export declare type SidebarProps<P = {}> = {
+    children: React.ReactNode;
+    /**
+     * Called on sidebar close (either by user action or by the editor).
+     */
+    onClose?: () => void | boolean;
+    /** if not supplied, sidebar won't be dockable */
+    onDock?: (docked: boolean) => void;
+    docked?: boolean;
+    dockable?: boolean;
+    className?: string;
+} & P;
+export declare type SidebarPropsContextValue = Pick<SidebarProps, "onClose" | "onDock" | "docked" | "dockable">;
+export declare const SidebarPropsContext: React.Context<SidebarPropsContextValue>;

package/types/components/hoc/withUpstreamOverride.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+export declare const withUpstreamOverride: <P>(Component: React.ComponentType<P>) => readonly [React.FC<{
+    children: React.ReactNode;
+}>, {
+    (props: P & {
+        /** @private internal */
+        __isFallback?: boolean | undefined;
+    }): JSX.Element | null;
+    displayName: string;
+}];

package/types/constants.d.ts

@@ -84,6 +84,9 @@ export declare const MIME_TYPES: {
     readonly "excalidraw.png": "image/png";
     readonly jpg: "image/jpeg";
     readonly gif: "image/gif";
+    readonly webp: "image/webp";
+    readonly bmp: "image/bmp";
+    readonly ico: "image/x-icon";
     readonly binary: "application/octet-stream";
 };
 export declare const EXPORT_DATA_TYPES: {
@@ -125,7 +128,7 @@ export declare const MAX_DECIMALS_FOR_SVG_EXPORT = 2;
 export declare const EXPORT_SCALES: number[];
 export declare const DEFAULT_EXPORT_PADDING = 10;
 export declare const DEFAULT_MAX_IMAGE_WIDTH_OR_HEIGHT = 1440;
-export declare const ALLOWED_IMAGE_MIME_TYPES: readonly ["image/png", "image/jpeg", "image/svg+xml", "image/gif"];
+export declare const ALLOWED_IMAGE_MIME_TYPES: readonly ["image/png", "image/jpeg", "image/svg+xml", "image/gif", "image/webp", "image/bmp", "image/x-icon"];
 export declare const MAX_ALLOWED_FILE_BYTES: number;
 export declare const SVG_NS = "http://www.w3.org/2000/svg";
 export declare const ENCRYPTION_KEY_BITS = 128;
@@ -148,3 +151,6 @@ export declare const ELEMENT_READY_TO_ERASE_OPACITY = 20;
 export declare const COOKIES: {
     readonly AUTH_STATE_COOKIE: "excplus-auth";
 };
+/** key containt id of precedeing elemnt id we use in reconciliation during
+ * collaboration */
+export declare const PRECEDING_ELEMENT_KEY = "__precedingElement__";

package/types/data/types.d.ts

@@ -10,12 +10,27 @@ export interface ExportedDataState {
     appState: ReturnType<typeof cleanAppStateForExport>;
     files: BinaryFiles | undefined;
 }
+/**
+ * Map of legacy AppState keys, with values of:
+ *  [<legacy type>, <new AppState proeprty>]
+ *
+ * This is a helper type used in downstream abstractions.
+ * Don't consume on its own.
+ */
+export declare type LegacyAppState = {
+    /** @deprecated #5663 TODO remove 22-12-15 */
+    isLibraryOpen: [boolean, "openSidebar"];
+    /** @deprecated #5663 TODO remove 22-12-15 */
+    isLibraryMenuDocked: [boolean, "isSidebarDocked"];
+};
 export interface ImportedDataState {
     type?: string;
     version?: number;
     source?: string;
     elements?: readonly ExcalidrawElement[] | null;
-    appState?: Readonly<Partial<AppState>> | null;
+    appState?: Readonly<Partial<AppState & {
+        [T in keyof LegacyAppState]: LegacyAppState[T][0];
+    }>> | null;
     scrollToContent?: boolean;
     libraryItems?: LibraryItems_anyVersion;
     files?: BinaryFiles;

package/types/element/Hyperlink.d.ts

@@ -72,6 +72,8 @@ export declare const actionLink: {
                 value: import("../types").NormalizedZoomValue;
             }>;
             openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
+            openSidebar: "library" | "customSidebar" | null;
+            isSidebarDocked: boolean;
             lastPointerDownWith: import("./types").PointerType;
             selectedElementIds: {
                 [id: string]: boolean;
@@ -98,8 +100,6 @@ export declare const actionLink: {
             height: number;
             offsetTop: number;
             offsetLeft: number;
-            isLibraryOpen: boolean;
-            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;

package/types/element/image.d.ts

@@ -10,7 +10,7 @@ export declare const updateImageCache: ({ fileIds, files, imageCache, }: {
 }) => Promise<{
     imageCache: Map<FileId, {
         image: HTMLImageElement | Promise<HTMLImageElement>;
-        mimeType: "image/svg+xml" | "image/png" | "image/jpeg" | "image/gif";
+        mimeType: "image/svg+xml" | "image/png" | "image/jpeg" | "image/gif" | "image/webp" | "image/bmp" | "image/x-icon";
     }>;
     /** includes errored files because they cache was updated nonetheless */
     updatedFiles: Map<FileId, true>;

package/types/element/linearElementEditor.d.ts

@@ -160,6 +160,8 @@ export declare class LinearElementEditor {
             }>;
             openMenu: "canvas" | "shape" | null;
             openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
+            openSidebar: "library" | "customSidebar" | null;
+            isSidebarDocked: boolean;
             lastPointerDownWith: import("./types").PointerType;
             selectedElementIds: {
                 [id: string]: boolean;
@@ -170,7 +172,7 @@ export declare class LinearElementEditor {
             shouldCacheIgnoreZoom: boolean;
             showHelpDialog: boolean;
             toast: {
-                message: string; /** @returns whether point was dragged */
+                message: string;
                 closable?: boolean | undefined;
                 duration?: number | undefined;
             } | null;
@@ -186,8 +188,6 @@ export declare class LinearElementEditor {
             height: number;
             offsetTop: number;
             offsetLeft: number;
-            isLibraryOpen: boolean;
-            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;

package/types/keys.d.ts

@@ -17,11 +17,8 @@ export declare const CODES: {
     readonly SLASH: "Slash";
     readonly C: "KeyC";
     readonly D: "KeyD";
-    readonly G: "KeyG";
-    readonly F: "KeyF";
     readonly H: "KeyH";
     readonly V: "KeyV";
-    readonly X: "KeyX";
     readonly Z: "KeyZ";
     readonly R: "KeyR";
 };
@@ -44,9 +41,12 @@ export declare const KEYS: {
     readonly PERIOD: ".";
     readonly COMMA: ",";
     readonly A: "a";
+    readonly C: "c";
     readonly D: "d";
     readonly E: "e";
+    readonly F: "f";
     readonly G: "g";
+    readonly H: "h";
     readonly I: "i";
     readonly L: "l";
     readonly O: "o";

package/types/packages/excalidraw/dist/excalidraw-assets-dev/locales/zh-TW-json-a05cd2023060266e8e0e.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: any;
+export = _exports;

package/types/packages/excalidraw/example/App.d.ts

@@ -1,7 +1,8 @@
+import type * as TExcalidraw from "../index";
 import "./App.scss";
 declare global {
     interface Window {
-        ExcalidrawLib: any;
+        ExcalidrawLib: typeof TExcalidraw;
     }
 }
 export default function App(): JSX.Element;

package/types/packages/excalidraw/example/sidebar/{Sidebar.d.ts → ExampleSidebar.d.ts}

@@ -1,5 +1,5 @@
 import React from "react";
-import "./Sidebar.scss";
+import "./ExampleSidebar.scss";
 export default function Sidebar({ children }: {
     children: React.ReactNode;
 }): JSX.Element;

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

@@ -13,3 +13,4 @@ export { FONT_FAMILY, THEME, MIME_TYPES } from "../../constants";
 export { mutateElement, newElementWith, bumpVersion, } from "../../element/mutateElement";
 export { parseLibraryTokensFromUrl, useHandleLibrary, } from "../../data/library";
 export { sceneCoordsToViewportCoords, viewportCoordsToSceneCoords, } from "../../utils";
+export { Sidebar } from "../../components/Sidebar/Sidebar";

package/types/types.d.ts

@@ -104,6 +104,8 @@ export declare type AppState = {
     zoom: Zoom;
     openMenu: "canvas" | "shape" | null;
     openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
+    openSidebar: "library" | "customSidebar" | null;
+    isSidebarDocked: boolean;
     lastPointerDownWith: PointerType;
     selectedElementIds: {
         [id: string]: boolean;
@@ -133,8 +135,6 @@ export declare type AppState = {
     height: number;
     offsetTop: number;
     offsetLeft: number;
-    isLibraryOpen: boolean;
-    isLibraryMenuDocked: boolean;
     fileHandle: FileSystemHandle | null;
     collaborators: Map<string, Collaborator>;
     showStats: boolean;
@@ -237,6 +237,10 @@ export interface ExcalidrawProps {
     }>) => 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;
 }
 export declare type SceneData = {
     elements?: ImportedDataState["elements"];
@@ -273,6 +277,7 @@ export declare type AppProps = Merge<ExcalidrawProps, {
     detectScroll: boolean;
     handleKeyboardGlobally: boolean;
     isCollaborating: boolean;
+    children?: React.ReactNode;
 }>;
 /** 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. */
@@ -369,6 +374,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"];
 };
 export declare type Device = Readonly<{
     isSmScreen: boolean;