@excalidraw/common 0.18.0-c65b684e9 → 0.18.0-c6f8ef9

package/dist/types/element/src/Scene.d.ts

@@ -27,7 +27,9 @@ export declare class Scene {
     getElementsMapIncludingDeleted(): Map<string, Ordered<ExcalidrawElement>> & import("@excalidraw/common/utility-types").MakeBrand<"SceneElementsMap">;
     getNonDeletedElements(): readonly Ordered<NonDeletedExcalidrawElement>[];
     getFramesIncludingDeleted(): readonly ExcalidrawFrameLikeElement[];
-    constructor(elements?: ElementsMapOrArray | null);
+    constructor(elements?: ElementsMapOrArray | null, options?: {
+        skipValidation?: true;
+    });
     getSelectedElements(opts: {
         selectedElementIds: AppState["selectedElementIds"];
         /**
@@ -55,7 +57,9 @@ export declare class Scene {
      * @returns whether a change was made
      */
     mapElements(iteratee: (element: ExcalidrawElement) => ExcalidrawElement): boolean;
-    replaceAllElements(nextElements: ElementsMapOrArray): void;
+    replaceAllElements(nextElements: ElementsMapOrArray, options?: {
+        skipValidation?: true;
+    }): void;
     triggerUpdate(): void;
     onUpdate(cb: SceneStateCallback): SceneStateCallbackRemover;
     destroy(): void;

package/dist/types/element/src/delta.d.ts

@@ -32,13 +32,13 @@ export declare class Delta<T> {
     /**
      * Merges two deltas into a new one.
      */
-    static merge<T>(delta1: Delta<T>, delta2: Delta<T>): Delta<T>;
+    static merge<T>(delta1: Delta<T>, delta2: Delta<T>, delta3?: Delta<T>): Delta<T>;
     /**
      * Merges deleted and inserted object partials.
      */
     static mergeObjects<T extends {
         [key: string]: unknown;
-    }>(prev: T, added: T, removed: T): T;
+    }>(prev: T, added: T, removed?: T): T;
     /**
      * Merges deleted and inserted array partials.
      */
@@ -118,6 +118,7 @@ export interface DeltaContainer<T> {
 export declare class AppStateDelta implements DeltaContainer<AppState> {
     delta: Delta<ObservedAppState>;
     private constructor();
+    static create(delta: Delta<ObservedAppState>): AppStateDelta;
     static calculate<T extends ObservedAppState>(prevAppState: T, nextAppState: T): AppStateDelta;
     static restore(appStateDeltaDTO: DTO<AppStateDelta>): AppStateDelta;
     static empty(): AppStateDelta;
@@ -131,7 +132,6 @@ export declare class AppStateDelta implements DeltaContainer<AppState> {
      * @returns `true` if a visible change is found, `false` otherwise.
      */
     private filterInvisibleChanges;
-    private static convertToAppStateKey;
     private static filterSelectedElements;
     private static filterSelectedGroups;
     private static stripElementsProps;
@@ -145,7 +145,7 @@ export declare class AppStateDelta implements DeltaContainer<AppState> {
 }
 type ElementPartial<TElement extends ExcalidrawElement = ExcalidrawElement> = Omit<Partial<Ordered<TElement>>, "id" | "updated" | "seed">;
 export type ApplyToOptions = {
-    excludedProperties: Set<keyof ElementPartial>;
+    excludedProperties?: Set<keyof ElementPartial>;
 };
 /**
  * Elements change is a low level primitive to capture a change between two sets of elements.
@@ -164,6 +164,7 @@ export declare class ElementsDelta implements DeltaContainer<SceneElementsMap> {
     private static satisfiesRemoval;
     private static satisfiesUpdate;
     private static satisfiesCommmonInvariants;
+    private static satisfiesUniqueInvariants;
     private static validate;
     /**
      * Calculates the `Delta`s between the previous and next set of elements.
@@ -213,6 +214,7 @@ export declare class ElementsDelta implements DeltaContainer<SceneElementsMap> {
      * should be rebound (if possible) with the current element ~ bindings should be bidirectional.
      */
     private static rebindAffected;
+    static redrawElements(nextElements: SceneElementsMap, changedElements: Map<string, OrderedExcalidrawElement>): SceneElementsMap;
     private static redrawTextBoundingBoxes;
     private static redrawBoundArrows;
     private static reorderElements;
@@ -222,5 +224,6 @@ export declare class ElementsDelta implements DeltaContainer<SceneElementsMap> {
      */
     private static postProcess;
     private static stripIrrelevantProps;
+    private static stripVersionProps;
 }
 export {};

package/dist/types/element/src/store.d.ts

@@ -169,7 +169,11 @@ export declare class StoreDelta {
     /**
      * Parse and load the delta from the remote payload.
      */
-    static load({ id, elements: { added, removed, updated }, }: DTO<StoreDelta>): StoreDelta;
+    static load({ id, elements: { added, removed, updated }, appState: { delta: appStateDelta }, }: DTO<StoreDelta>): StoreDelta;
+    /**
+     * Squash the passed deltas into the aggregated delta instance.
+     */
+    static squash(...deltas: StoreDelta[]): StoreDelta;
     /**
      * Inverse store delta, creates new instance of `StoreDelta`.
      */
@@ -182,6 +186,7 @@ export declare class StoreDelta {
      * Apply latest (remote) changes to the delta, creates new instance of `StoreDelta`.
      */
     static applyLatestChanges(delta: StoreDelta, prevElements: SceneElementsMap, nextElements: SceneElementsMap, modifierOptions?: "deleted" | "inserted"): StoreDelta;
+    static empty(): StoreDelta;
     isEmpty(): boolean;
 }
 /**

package/dist/types/excalidraw/actions/actionCanvas.d.ts

@@ -160,7 +160,6 @@ export declare const actionClearCanvas: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -278,7 +277,6 @@ export declare const actionZoomIn: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -465,7 +463,6 @@ export declare const actionZoomOut: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -652,7 +649,6 @@ export declare const actionResetZoom: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -845,7 +841,6 @@ export declare const zoomToFitBounds: ({ bounds, appState, canvasOffsets, fitToV
         openMenu: "canvas" | "shape" | null;
         openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
         openSidebar: {
-            /** zoom content to cover X of the viewport, when fitToViewport=true */
             name: string;
             tab?: string | undefined;
         } | null;
@@ -1034,7 +1029,6 @@ export declare const zoomToFit: ({ canvasOffsets, targetElements, appState, fitT
         openMenu: "canvas" | "shape" | null;
         openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
         openSidebar: {
-            /** zoom content to cover X of the viewport, when fitToViewport=true */
             name: string;
             tab?: string | undefined;
         } | null;
@@ -1215,7 +1209,6 @@ export declare const actionZoomToFitSelectionInViewport: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -1400,7 +1393,6 @@ export declare const actionZoomToFitSelection: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -1586,7 +1578,6 @@ export declare const actionZoomToFit: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -1774,7 +1765,6 @@ export declare const actionToggleTheme: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -1957,7 +1947,6 @@ export declare const actionToggleEraserTool: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -2135,7 +2124,6 @@ export declare const actionToggleLassoTool: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;
@@ -2313,7 +2301,6 @@ export declare const actionToggleHandTool: {
             openMenu: "canvas" | "shape" | null;
             openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | null;
             openSidebar: {
-                /** zoom content to cover X of the viewport, when fitToViewport=true */
                 name: string;
                 tab?: string | undefined;
             } | null;

package/dist/types/excalidraw/components/App.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { type EXPORT_IMAGE_TYPES, Emitter } from "@excalidraw/common";
-import { LinearElementEditor, FlowChartCreator, Scene, Store, type ElementUpdate } from "@excalidraw/element";
-import type { ExcalidrawElement, NonDeleted, NonDeletedExcalidrawElement, ExcalidrawFrameLikeElement, ExcalidrawIframeElement, ExcalidrawEmbeddableElement, Ordered } from "@excalidraw/element/types";
+import { LinearElementEditor, FlowChartCreator, Scene, Store, type ElementUpdate, StoreDelta, type ApplyToOptions } from "@excalidraw/element";
+import type { ExcalidrawElement, NonDeleted, NonDeletedExcalidrawElement, ExcalidrawFrameLikeElement, ExcalidrawIframeElement, ExcalidrawEmbeddableElement, Ordered, SceneElementsMap } from "@excalidraw/element/types";
 import type { Mutable } from "@excalidraw/common/utility-types";
 import { ActionManager } from "../actions/manager";
 import { AnimationFrameHandler } from "../animation-frame-handler";
@@ -397,6 +397,7 @@ declare class App extends React.Component<AppProps, AppState> {
          */
         captureUpdate?: SceneData["captureUpdate"];
     }) => void;
+    applyDeltas: (deltas: StoreDelta[], options?: ApplyToOptions) => [SceneElementsMap, AppState, boolean];
     mutateElement: <TElement extends Mutable<ExcalidrawElement>>(element: TElement, updates: ElementUpdate<TElement>, informMutation?: boolean) => TElement;
     private triggerRender;
     /**

package/dist/types/excalidraw/data/reconcile.d.ts

@@ -3,4 +3,5 @@ import type { MakeBrand } from "@excalidraw/common/utility-types";
 import type { AppState } from "../types";
 export type ReconciledExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"ReconciledElement">;
 export type RemoteExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"RemoteExcalidrawElement">;
+export declare const shouldDiscardRemoteElement: (localAppState: AppState, local: OrderedExcalidrawElement | undefined, remote: RemoteExcalidrawElement) => boolean;
 export declare const reconcileElements: (localElements: readonly OrderedExcalidrawElement[], remoteElements: readonly RemoteExcalidrawElement[], localAppState: AppState) => ReconciledExcalidrawElement[];

package/dist/types/excalidraw/data/restore.d.ts

@@ -1,4 +1,4 @@
-import type { ExcalidrawElement, OrderedExcalidrawElement } from "@excalidraw/element/types";
+import type { ExcalidrawArrowElement, ExcalidrawElement, ExcalidrawLinearElement, ExcalidrawSelectionElement, ExcalidrawTextElement, OrderedExcalidrawElement } from "@excalidraw/element/types";
 import type { AppState, BinaryFiles, LibraryItem } from "../types";
 import type { ImportedDataState } from "./types";
 type RestoredAppState = Omit<AppState, "offsetTop" | "offsetLeft" | "width" | "height">;
@@ -8,14 +8,19 @@ export type RestoredDataState = {
     appState: RestoredAppState;
     files: BinaryFiles;
 };
+export declare const restoreElement: (element: Exclude<ExcalidrawElement, ExcalidrawSelectionElement>, opts?: {
+    deleteInvisibleElements?: boolean;
+}) => ExcalidrawTextElement | import("@excalidraw/element/types").ExcalidrawRectangleElement | import("@excalidraw/element/types").ExcalidrawDiamondElement | import("@excalidraw/element/types").ExcalidrawFrameElement | import("@excalidraw/element/types").ExcalidrawMagicFrameElement | import("@excalidraw/element/types").ExcalidrawEmbeddableElement | import("@excalidraw/element/types").ExcalidrawImageElement | import("@excalidraw/element/types").ExcalidrawIframeElement | import("@excalidraw/element/types").ExcalidrawEllipseElement | ExcalidrawLinearElement | ExcalidrawArrowElement | import("@excalidraw/element/types").ExcalidrawFreeDrawElement | null;
 export declare const restoreElements: (elements: ImportedDataState["elements"], localElements: readonly ExcalidrawElement[] | null | undefined, opts?: {
     refreshDimensions?: boolean;
     repairBindings?: boolean;
+    deleteInvisibleElements?: boolean;
 } | undefined) => OrderedExcalidrawElement[];
 export declare const restoreAppState: (appState: ImportedDataState["appState"], localAppState: Partial<AppState> | null | undefined) => RestoredAppState;
 export declare const restore: (data: Pick<ImportedDataState, "appState" | "elements" | "files"> | null, localAppState: Partial<AppState> | null | undefined, localElements: readonly ExcalidrawElement[] | null | undefined, elementsConfig?: {
     refreshDimensions?: boolean;
     repairBindings?: boolean;
+    deleteInvisibleElements?: boolean;
 }) => RestoredDataState;
 export declare const restoreLibraryItems: (libraryItems: ImportedDataState["libraryItems"], defaultStatus: LibraryItem["status"]) => LibraryItem[];
 export {};

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

@@ -12,7 +12,7 @@ export { getSceneVersion, hashElementsVersion, hashString, getNonDeletedElements
 export { getTextFromElements } from "@excalidraw/element";
 export { isInvisiblySmallElement } from "@excalidraw/element";
 export { defaultLang, useI18n, languages } from "./i18n";
-export { restore, restoreAppState, restoreElements, restoreLibraryItems, } from "./data/restore";
+export { restore, restoreAppState, restoreElement, restoreElements, restoreLibraryItems, } from "./data/restore";
 export { reconcileElements } from "./data/reconcile";
 export { exportToCanvas, exportToBlob, exportToSvg, exportToClipboard, } from "@excalidraw/utils/export";
 export { serializeAsJSON, serializeLibraryAsJSON } from "./data/json";

package/dist/types/excalidraw/types.d.ts

@@ -155,8 +155,10 @@ export type ObservedElementsAppState = {
     editingGroupId: AppState["editingGroupId"];
     selectedElementIds: AppState["selectedElementIds"];
     selectedGroupIds: AppState["selectedGroupIds"];
-    selectedLinearElementId: LinearElementEditor["elementId"] | null;
-    selectedLinearElementIsEditing: boolean | null;
+    selectedLinearElement: {
+        elementId: LinearElementEditor["elementId"];
+        isEditing: boolean;
+    } | null;
     croppingElementId: AppState["croppingElementId"];
     lockedMultiSelections: AppState["lockedMultiSelections"];
     activeLockedId: AppState["activeLockedId"];
@@ -616,6 +618,7 @@ export type PointerDownState = Readonly<{
 export type UnsubscribeCallback = () => void;
 export interface ExcalidrawImperativeAPI {
     updateScene: InstanceType<typeof App>["updateScene"];
+    applyDeltas: InstanceType<typeof App>["applyDeltas"];
     mutateElement: InstanceType<typeof App>["mutateElement"];
     updateLibrary: InstanceType<typeof Library>["updateLibrary"];
     resetScene: InstanceType<typeof App>["resetScene"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@excalidraw/common",
-  "version": "0.18.0-c65b684e9",
+  "version": "0.18.0-c6f8ef9",
   "type": "module",
   "types": "./dist/types/common/src/index.d.ts",
   "main": "./dist/prod/index.js",