@dwelle/excalidraw 0.3.78 → 0.4.0-08c4fac

package/types/data/json.d.ts

@@ -1,16 +1,16 @@
-import { ExcalidrawElement } from "../element/types";
-import { AppState, BinaryFiles, LibraryItems } from "../types";
-import { ImportedDataState, ImportedLibraryData } from "./types";
-export declare const serializeAsJSON: (elements: readonly ExcalidrawElement[], appState: Partial<AppState>, files: BinaryFiles, type: "local" | "database") => string;
-export declare const saveAsJSON: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => Promise<{
-    fileHandle: import("browser-fs-access").FileSystemHandle | null;
-}>;
-export declare const loadFromJSON: (localAppState: AppState, localElements: readonly ExcalidrawElement[] | null) => Promise<import("./restore").RestoredDataState>;
-export declare const isValidExcalidrawData: (data?: {
-    type?: any;
-    elements?: any;
-    appState?: any;
-}) => data is ImportedDataState;
-export declare const isValidLibrary: (json: any) => json is ImportedLibraryData;
-export declare const serializeLibraryAsJSON: (libraryItems: LibraryItems) => string;
-export declare const saveLibraryAsJSON: (libraryItems: LibraryItems) => Promise<void>;
+import { ExcalidrawElement } from "../element/types";
+import { AppState, BinaryFiles, LibraryItems } from "../types";
+import { ImportedDataState, ImportedLibraryData } from "./types";
+export declare const serializeAsJSON: (elements: readonly ExcalidrawElement[], appState: Partial<AppState>, files: BinaryFiles, type: "local" | "database") => string;
+export declare const saveAsJSON: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => Promise<{
+    fileHandle: import("browser-fs-access").FileSystemHandle | null;
+}>;
+export declare const loadFromJSON: (localAppState: AppState, localElements: readonly ExcalidrawElement[] | null) => Promise<import("./restore").RestoredDataState>;
+export declare const isValidExcalidrawData: (data?: {
+    type?: any;
+    elements?: any;
+    appState?: any;
+}) => data is ImportedDataState;
+export declare const isValidLibrary: (json: any) => json is ImportedLibraryData;
+export declare const serializeLibraryAsJSON: (libraryItems: LibraryItems) => string;
+export declare const saveLibraryAsJSON: (libraryItems: LibraryItems) => Promise<void>;

package/types/data/library.d.ts

@@ -1,96 +1,96 @@
-import { LibraryItems, ExcalidrawImperativeAPI, LibraryItemsSource } from "../types";
-import type App from "../components/App";
-import { ExcalidrawElement } from "../element/types";
-export declare const libraryItemsAtom: import("jotai").Atom<{
-    status: "loading" | "loaded";
-    isInitialized: boolean;
-    libraryItems: LibraryItems;
-}> & {
-    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: {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    } | ((prev: {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    }) => {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    })) => void;
-    onMount?: (<S extends (update: {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    } | ((prev: {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    }) => {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    })) => void>(setAtom: S) => void | (() => void)) | undefined;
-} & {
-    init: {
-        status: "loading" | "loaded";
-        isInitialized: boolean;
-        libraryItems: LibraryItems;
-    };
-};
-/** Merges otherItems into localItems. Unique items in otherItems array are
-    sorted first. */
-export declare const mergeLibraryItems: (localItems: LibraryItems, otherItems: LibraryItems) => LibraryItems;
-declare class Library {
-    /** latest libraryItems */
-    private lastLibraryItems;
-    /** indicates whether library is initialized with library items (has gone
-     * though at least one update) */
-    private isInitialized;
-    private app;
-    constructor(app: App);
-    private updateQueue;
-    private getLastUpdateTask;
-    private notifyListeners;
-    resetLibrary: () => Promise<LibraryItems>;
-    /**
-     * @returns latest cloned libraryItems. Awaits all in-progress updates first.
-     */
-    getLatestLibrary: () => Promise<LibraryItems>;
-    updateLibrary: ({ libraryItems, prompt, merge, openLibraryMenu, defaultStatus, }: {
-        libraryItems: LibraryItemsSource;
-        merge?: boolean | undefined;
-        prompt?: boolean | undefined;
-        openLibraryMenu?: boolean | undefined;
-        defaultStatus?: "published" | "unpublished" | undefined;
-    }) => Promise<LibraryItems>;
-    setLibrary: (libraryItems: LibraryItems | Promise<LibraryItems> | ((latestLibraryItems: LibraryItems) => LibraryItems | Promise<LibraryItems>)) => Promise<LibraryItems>;
-}
-export default Library;
-export declare const distributeLibraryItemsOnSquareGrid: (libraryItems: LibraryItems) => ExcalidrawElement[];
-export declare const parseLibraryTokensFromUrl: () => {
-    libraryUrl: string;
-    idToken: string | null;
-} | null;
-export declare const useHandleLibrary: ({ excalidrawAPI, getInitialLibraryItems, }: {
-    excalidrawAPI: ExcalidrawImperativeAPI | null;
-    getInitialLibraryItems?: (() => LibraryItemsSource) | undefined;
-}) => void;
+import { LibraryItems, ExcalidrawImperativeAPI, LibraryItemsSource } from "../types";
+import type App from "../components/App";
+import { ExcalidrawElement } from "../element/types";
+export declare const libraryItemsAtom: import("jotai").Atom<{
+    status: "loading" | "loaded";
+    isInitialized: boolean;
+    libraryItems: LibraryItems;
+}> & {
+    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: {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    } | ((prev: {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    }) => {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    })) => void;
+    onMount?: (<S extends (update: {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    } | ((prev: {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    }) => {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    })) => void>(setAtom: S) => void | (() => void)) | undefined;
+} & {
+    init: {
+        status: "loading" | "loaded";
+        isInitialized: boolean;
+        libraryItems: LibraryItems;
+    };
+};
+/** Merges otherItems into localItems. Unique items in otherItems array are
+    sorted first. */
+export declare const mergeLibraryItems: (localItems: LibraryItems, otherItems: LibraryItems) => LibraryItems;
+declare class Library {
+    /** latest libraryItems */
+    private lastLibraryItems;
+    /** indicates whether library is initialized with library items (has gone
+     * though at least one update) */
+    private isInitialized;
+    private app;
+    constructor(app: App);
+    private updateQueue;
+    private getLastUpdateTask;
+    private notifyListeners;
+    resetLibrary: () => Promise<LibraryItems>;
+    /**
+     * @returns latest cloned libraryItems. Awaits all in-progress updates first.
+     */
+    getLatestLibrary: () => Promise<LibraryItems>;
+    updateLibrary: ({ libraryItems, prompt, merge, openLibraryMenu, defaultStatus, }: {
+        libraryItems: LibraryItemsSource;
+        merge?: boolean | undefined;
+        prompt?: boolean | undefined;
+        openLibraryMenu?: boolean | undefined;
+        defaultStatus?: "published" | "unpublished" | undefined;
+    }) => Promise<LibraryItems>;
+    setLibrary: (libraryItems: LibraryItems | Promise<LibraryItems> | ((latestLibraryItems: LibraryItems) => LibraryItems | Promise<LibraryItems>)) => Promise<LibraryItems>;
+}
+export default Library;
+export declare const distributeLibraryItemsOnSquareGrid: (libraryItems: LibraryItems) => ExcalidrawElement[];
+export declare const parseLibraryTokensFromUrl: () => {
+    libraryUrl: string;
+    idToken: string | null;
+} | null;
+export declare const useHandleLibrary: ({ excalidrawAPI, getInitialLibraryItems, }: {
+    excalidrawAPI: ExcalidrawImperativeAPI | null;
+    getInitialLibraryItems?: (() => LibraryItemsSource) | undefined;
+}) => void;

package/types/data/resave.d.ts

@@ -1,5 +1,5 @@
-import { ExcalidrawElement } from "../element/types";
-import { AppState, BinaryFiles } from "../types";
-export declare const resaveAsImageWithScene: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => Promise<{
-    fileHandle: import("browser-fs-access").FileSystemHandle;
-}>;
+import { ExcalidrawElement } from "../element/types";
+import { AppState, BinaryFiles } from "../types";
+export declare const resaveAsImageWithScene: (elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles) => Promise<{
+    fileHandle: import("browser-fs-access").FileSystemHandle;
+}>;

package/types/data/restore.d.ts

@@ -1,15 +1,15 @@
-import { ExcalidrawElement } from "../element/types";
-import { AppState, BinaryFiles, LibraryItem } from "../types";
-import { ImportedDataState } from "./types";
-declare type RestoredAppState = Omit<AppState, "offsetTop" | "offsetLeft" | "width" | "height">;
-export declare const AllowedExcalidrawActiveTools: Record<AppState["activeTool"]["type"], boolean>;
-export declare type RestoredDataState = {
-    elements: ExcalidrawElement[];
-    appState: RestoredAppState;
-    files: BinaryFiles;
-};
-export declare const restoreElements: (elements: ImportedDataState["elements"], localElements: readonly ExcalidrawElement[] | null | undefined) => ExcalidrawElement[];
-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) => RestoredDataState;
-export declare const restoreLibraryItems: (libraryItems: ImportedDataState["libraryItems"], defaultStatus: LibraryItem["status"]) => LibraryItem[];
-export {};
+import { ExcalidrawElement } from "../element/types";
+import { AppState, BinaryFiles, LibraryItem } from "../types";
+import { ImportedDataState } from "./types";
+declare type RestoredAppState = Omit<AppState, "offsetTop" | "offsetLeft" | "width" | "height">;
+export declare const AllowedExcalidrawActiveTools: Record<AppState["activeTool"]["type"], boolean>;
+export declare type RestoredDataState = {
+    elements: ExcalidrawElement[];
+    appState: RestoredAppState;
+    files: BinaryFiles;
+};
+export declare const restoreElements: (elements: ImportedDataState["elements"], localElements: readonly ExcalidrawElement[] | null | undefined, refreshDimensions?: boolean) => ExcalidrawElement[];
+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) => RestoredDataState;
+export declare const restoreLibraryItems: (libraryItems: ImportedDataState["libraryItems"], defaultStatus: LibraryItem["status"]) => LibraryItem[];
+export {};

package/types/data/types.d.ts

@@ -1,32 +1,47 @@
-import { ExcalidrawElement } from "../element/types";
-import { AppState, BinaryFiles, LibraryItems, LibraryItems_anyVersion } from "../types";
-import type { cleanAppStateForExport } from "../appState";
-import { VERSIONS } from "../constants";
-export interface ExportedDataState {
-    type: string;
-    version: number;
-    source: string;
-    elements: readonly ExcalidrawElement[];
-    appState: ReturnType<typeof cleanAppStateForExport>;
-    files: BinaryFiles | undefined;
-}
-export interface ImportedDataState {
-    type?: string;
-    version?: number;
-    source?: string;
-    elements?: readonly ExcalidrawElement[] | null;
-    appState?: Readonly<Partial<AppState>> | null;
-    scrollToContent?: boolean;
-    libraryItems?: LibraryItems_anyVersion;
-    files?: BinaryFiles;
-}
-export interface ExportedLibraryData {
-    type: string;
-    version: typeof VERSIONS.excalidrawLibrary;
-    source: string;
-    libraryItems: LibraryItems;
-}
-export interface ImportedLibraryData extends Partial<ExportedLibraryData> {
-    /** @deprecated v1 */
-    library?: LibraryItems;
-}
+import { ExcalidrawElement } from "../element/types";
+import { AppState, BinaryFiles, LibraryItems, LibraryItems_anyVersion } from "../types";
+import type { cleanAppStateForExport } from "../appState";
+import { VERSIONS } from "../constants";
+export interface ExportedDataState {
+    type: string;
+    version: number;
+    source: string;
+    elements: readonly ExcalidrawElement[];
+    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 & {
+        [T in keyof LegacyAppState]: LegacyAppState[T][0];
+    }>> | null;
+    scrollToContent?: boolean;
+    libraryItems?: LibraryItems_anyVersion;
+    files?: BinaryFiles;
+}
+export interface ExportedLibraryData {
+    type: string;
+    version: typeof VERSIONS.excalidrawLibrary;
+    source: string;
+    libraryItems: LibraryItems;
+}
+export interface ImportedLibraryData extends Partial<ExportedLibraryData> {
+    /** @deprecated v1 */
+    library?: LibraryItems;
+}

package/types/distribute.d.ts

@@ -1,6 +1,6 @@
-import { ExcalidrawElement } from "./element/types";
-export interface Distribution {
-    space: "between";
-    axis: "x" | "y";
-}
-export declare const distributeElements: (selectedElements: ExcalidrawElement[], distribution: Distribution) => ExcalidrawElement[];
+import { ExcalidrawElement } from "./element/types";
+export interface Distribution {
+    space: "between";
+    axis: "x" | "y";
+}
+export declare const distributeElements: (selectedElements: ExcalidrawElement[], distribution: Distribution) => ExcalidrawElement[];