@zsviczian/excalidraw 0.18.0-1 → 0.18.0-3

package/types/excalidraw/data/blob.d.ts

@@ -1,53 +1,53 @@
-import { IMAGE_MIME_TYPES, MIME_TYPES } from "../constants";
-import type { ExcalidrawElement, FileId } from "../element/types";
-import type { AppState, DataURL, LibraryItem } from "../types";
-import type { ValueOf } from "../utility-types";
-import type { FileSystemHandle } from "./filesystem";
-import type { ImportedLibraryData } from "./types";
-export declare const getMimeType: (blob: Blob | string) => string;
-export declare const getFileHandleType: (handle: FileSystemHandle | null) => string | null;
-export declare const isImageFileHandleType: (type: string | null) => type is "svg" | "png";
-export declare const isImageFileHandle: (handle: FileSystemHandle | null) => boolean;
-export declare const isSupportedImageFileType: (type: string | null | undefined) => boolean;
-export declare const isSupportedImageFile: (blob: Blob | null | undefined) => blob is Blob & {
-    type: ValueOf<typeof IMAGE_MIME_TYPES>;
-};
-export declare const loadSceneOrLibraryFromBlob: (blob: Blob | File, localAppState: AppState | null, localElements: readonly ExcalidrawElement[] | null, fileHandle?: FileSystemHandle | null) => Promise<{
-    type: "application/vnd.excalidraw+json";
-    data: import("./restore").RestoredDataState;
-} | {
-    type: "application/vnd.excalidrawlib+json";
-    data: ImportedLibraryData;
-}>;
-export declare const loadFromBlob: (blob: Blob, localAppState: AppState | null, localElements: readonly ExcalidrawElement[] | null, fileHandle?: FileSystemHandle | null) => Promise<import("./restore").RestoredDataState>;
-export declare const parseLibraryJSON: (json: string, defaultStatus?: LibraryItem["status"]) => LibraryItem[];
-export declare const loadLibraryFromBlob: (blob: Blob, defaultStatus?: LibraryItem["status"]) => Promise<LibraryItem[]>;
-export declare const canvasToBlob: (canvas: HTMLCanvasElement | Promise<HTMLCanvasElement>) => Promise<Blob>;
-/** generates SHA-1 digest from supplied file (if not supported, falls back
-    to a 40-char base64 random id) */
-export declare const generateIdFromFile: (file: File) => Promise<FileId>;
-/** async. For sync variant, use getDataURL_sync */
-export declare const getDataURL: (file: Blob | File) => Promise<DataURL>;
-export declare const getDataURL_sync: (data: string | Uint8Array | ArrayBuffer, mimeType: ValueOf<typeof MIME_TYPES>) => DataURL;
-export declare const dataURLToFile: (dataURL: DataURL, filename?: string) => File;
-export declare const dataURLToString: (dataURL: DataURL) => string;
-export declare const resizeImageFile: (file: File, opts: {
-    /** undefined indicates auto */
-    outputType?: (typeof MIME_TYPES)["jpg"];
-    maxWidthOrHeight: number;
-}) => Promise<File>;
-export declare const SVGStringToFile: (SVGString: string, filename?: string) => File & {
-    type: typeof MIME_TYPES.svg;
-};
-export declare const ImageURLToFile: (imageUrl: string, filename?: string) => Promise<File | undefined>;
-export declare const getFileFromEvent: (event: React.DragEvent<HTMLDivElement>) => Promise<{
-    file: File | null;
-    fileHandle: FileSystemHandle | null;
-}>;
-export declare const getFileHandle: (event: React.DragEvent<HTMLDivElement>) => Promise<FileSystemHandle | null>;
-export declare const createFile: (blob: File | Blob | ArrayBuffer, mimeType: ValueOf<typeof MIME_TYPES>, name: string | undefined) => File;
-/** attempts to detect correct mimeType if none is set, or if an image
- * has an incorrect extension.
- * Note: doesn't handle missing .excalidraw/.excalidrawlib extension  */
-export declare const normalizeFile: (file: File) => Promise<File>;
-export declare const blobToArrayBuffer: (blob: Blob) => Promise<ArrayBuffer>;
+import { IMAGE_MIME_TYPES, MIME_TYPES } from "../constants";
+import type { FileSystemHandle } from "./filesystem";
+import type { ExcalidrawElement, FileId } from "../element/types";
+import type { AppState, DataURL, LibraryItem } from "../types";
+import type { ValueOf } from "../utility-types";
+import type { ImportedLibraryData } from "./types";
+export declare const getMimeType: (blob: Blob | string) => string;
+export declare const getFileHandleType: (handle: FileSystemHandle | null) => string | null;
+export declare const isImageFileHandleType: (type: string | null) => type is "svg" | "png";
+export declare const isImageFileHandle: (handle: FileSystemHandle | null) => boolean;
+export declare const isSupportedImageFileType: (type: string | null | undefined) => boolean;
+export declare const isSupportedImageFile: (blob: Blob | null | undefined) => blob is Blob & {
+    type: ValueOf<typeof IMAGE_MIME_TYPES>;
+};
+export declare const loadSceneOrLibraryFromBlob: (blob: Blob | File, localAppState: AppState | null, localElements: readonly ExcalidrawElement[] | null, fileHandle?: FileSystemHandle | null) => Promise<{
+    type: "application/vnd.excalidraw+json";
+    data: import("./restore").RestoredDataState;
+} | {
+    type: "application/vnd.excalidrawlib+json";
+    data: ImportedLibraryData;
+}>;
+export declare const loadFromBlob: (blob: Blob, localAppState: AppState | null, localElements: readonly ExcalidrawElement[] | null, fileHandle?: FileSystemHandle | null) => Promise<import("./restore").RestoredDataState>;
+export declare const parseLibraryJSON: (json: string, defaultStatus?: LibraryItem["status"]) => LibraryItem[];
+export declare const loadLibraryFromBlob: (blob: Blob, defaultStatus?: LibraryItem["status"]) => Promise<LibraryItem[]>;
+export declare const canvasToBlob: (canvas: HTMLCanvasElement | Promise<HTMLCanvasElement>) => Promise<Blob>;
+/** generates SHA-1 digest from supplied file (if not supported, falls back
+    to a 40-char base64 random id) */
+export declare const generateIdFromFile: (file: File) => Promise<FileId>;
+/** async. For sync variant, use getDataURL_sync */
+export declare const getDataURL: (file: Blob | File) => Promise<DataURL>;
+export declare const getDataURL_sync: (data: string | Uint8Array | ArrayBuffer, mimeType: ValueOf<typeof MIME_TYPES>) => DataURL;
+export declare const dataURLToFile: (dataURL: DataURL, filename?: string) => File;
+export declare const dataURLToString: (dataURL: DataURL) => string;
+export declare const resizeImageFile: (file: File, opts: {
+    /** undefined indicates auto */
+    outputType?: (typeof MIME_TYPES)["jpg"];
+    maxWidthOrHeight: number;
+}) => Promise<File>;
+export declare const SVGStringToFile: (SVGString: string, filename?: string) => File & {
+    type: typeof MIME_TYPES.svg;
+};
+export declare const ImageURLToFile: (imageUrl: string, filename?: string) => Promise<File | undefined>;
+export declare const getFileFromEvent: (event: React.DragEvent<HTMLDivElement>) => Promise<{
+    file: File | null;
+    fileHandle: FileSystemHandle | null;
+}>;
+export declare const getFileHandle: (event: React.DragEvent<HTMLDivElement>) => Promise<FileSystemHandle | null>;
+export declare const createFile: (blob: File | Blob | ArrayBuffer, mimeType: ValueOf<typeof MIME_TYPES>, name: string | undefined) => File;
+/** attempts to detect correct mimeType if none is set, or if an image
+ * has an incorrect extension.
+ * Note: doesn't handle missing .excalidraw/.excalidrawlib extension  */
+export declare const normalizeFile: (file: File) => Promise<File>;
+export declare const blobToArrayBuffer: (blob: Blob) => Promise<ArrayBuffer>;

package/types/excalidraw/data/encode.d.ts

@@ -1,55 +1,55 @@
-export declare const toByteString: (data: string | Uint8Array | ArrayBuffer) => string;
-/**
- * @param isByteString set to true if already byte string to prevent bloat
- *  due to reencoding
- */
-export declare const stringToBase64: (str: string, isByteString?: boolean) => string;
-export declare const base64ToString: (base64: string, isByteString?: boolean) => string;
-export declare const base64ToArrayBuffer: (base64: string) => ArrayBuffer;
-export declare const base64urlToString: (str: string) => string;
-type EncodedData = {
-    encoded: string;
-    encoding: "bstring";
-    /** whether text is compressed (zlib) */
-    compressed: boolean;
-    /** version for potential migration purposes */
-    version?: string;
-};
-/**
- * Encodes (and potentially compresses via zlib) text to byte string
- */
-export declare const encode: ({ text, compress, }: {
-    text: string;
-    /** defaults to `true`. If compression fails, falls back to bstring alone. */
-    compress?: boolean | undefined;
-}) => EncodedData;
-export declare const decode: (data: EncodedData) => string;
-/**
- * The returned buffer has following format:
- * `[]` refers to a buffers wrapper (see `concatBuffers`)
- *
- * [
- *   encodingMetadataBuffer,
- *   iv,
- *   [
- *      contentsMetadataBuffer
- *      contentsBuffer
- *   ]
- * ]
- */
-export declare const compressData: <T extends Record<string, any> = never>(dataBuffer: Uint8Array, options: {
-    encryptionKey: string;
-} & ([T] extends [never] ? {
-    metadata?: T | undefined;
-} : {
-    metadata: T;
-})) => Promise<Uint8Array>;
-export declare const decompressData: <T extends Record<string, any>>(bufferView: Uint8Array, options: {
-    decryptionKey: string;
-}) => Promise<{
-    /** metadata source is always JSON so we can decode it here */
-    metadata: T;
-    /** data can be anything so the caller must decode it */
-    data: Uint8Array;
-}>;
-export {};
+export declare const toByteString: (data: string | Uint8Array | ArrayBuffer) => string;
+/**
+ * @param isByteString set to true if already byte string to prevent bloat
+ *  due to reencoding
+ */
+export declare const stringToBase64: (str: string, isByteString?: boolean) => string;
+export declare const base64ToString: (base64: string, isByteString?: boolean) => string;
+export declare const base64ToArrayBuffer: (base64: string) => ArrayBuffer;
+export declare const base64urlToString: (str: string) => string;
+type EncodedData = {
+    encoded: string;
+    encoding: "bstring";
+    /** whether text is compressed (zlib) */
+    compressed: boolean;
+    /** version for potential migration purposes */
+    version?: string;
+};
+/**
+ * Encodes (and potentially compresses via zlib) text to byte string
+ */
+export declare const encode: ({ text, compress, }: {
+    text: string;
+    /** defaults to `true`. If compression fails, falls back to bstring alone. */
+    compress?: boolean | undefined;
+}) => EncodedData;
+export declare const decode: (data: EncodedData) => string;
+/**
+ * The returned buffer has following format:
+ * `[]` refers to a buffers wrapper (see `concatBuffers`)
+ *
+ * [
+ *   encodingMetadataBuffer,
+ *   iv,
+ *   [
+ *      contentsMetadataBuffer
+ *      contentsBuffer
+ *   ]
+ * ]
+ */
+export declare const compressData: <T extends Record<string, any> = never>(dataBuffer: Uint8Array, options: {
+    encryptionKey: string;
+} & ([T] extends [never] ? {
+    metadata?: T | undefined;
+} : {
+    metadata: T;
+})) => Promise<Uint8Array>;
+export declare const decompressData: <T extends Record<string, any>>(bufferView: Uint8Array, options: {
+    decryptionKey: string;
+}) => Promise<{
+    /** metadata source is always JSON so we can decode it here */
+    metadata: T;
+    /** data can be anything so the caller must decode it */
+    data: Uint8Array;
+}>;
+export {};

package/types/excalidraw/data/encryption.d.ts

@@ -1,9 +1,9 @@
-export declare const IV_LENGTH_BYTES = 12;
-export declare const createIV: () => Uint8Array;
-export declare const generateEncryptionKey: <T extends "string" | "cryptoKey" = "string">(returnAs?: T | undefined) => Promise<T extends "cryptoKey" ? CryptoKey : string>;
-export declare const getCryptoKey: (key: string, usage: KeyUsage) => Promise<CryptoKey>;
-export declare const encryptData: (key: string | CryptoKey, data: Uint8Array | ArrayBuffer | Blob | File | string) => Promise<{
-    encryptedBuffer: ArrayBuffer;
-    iv: Uint8Array;
-}>;
-export declare const decryptData: (iv: Uint8Array, encrypted: Uint8Array | ArrayBuffer, privateKey: string) => Promise<ArrayBuffer>;
+export declare const IV_LENGTH_BYTES = 12;
+export declare const createIV: () => Uint8Array;
+export declare const generateEncryptionKey: <T extends "string" | "cryptoKey" = "string">(returnAs?: T | undefined) => Promise<T extends "cryptoKey" ? CryptoKey : string>;
+export declare const getCryptoKey: (key: string, usage: KeyUsage) => Promise<CryptoKey>;
+export declare const encryptData: (key: string | CryptoKey, data: Uint8Array | ArrayBuffer | Blob | File | string) => Promise<{
+    encryptedBuffer: ArrayBuffer;
+    iv: Uint8Array;
+}>;
+export declare const decryptData: (iv: Uint8Array, encrypted: Uint8Array | ArrayBuffer, privateKey: string) => Promise<ArrayBuffer>;

package/types/excalidraw/data/filesystem.d.ts

@@ -1,21 +1,21 @@
-import type { FileSystemHandle } from "browser-fs-access";
-import { supported as nativeFileSystemSupported } from "browser-fs-access";
-import { MIME_TYPES } from "../constants";
-type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
-export declare const fileOpen: <M extends boolean | undefined = false>(opts: {
-    extensions?: FILE_EXTENSION[] | undefined;
-    description: string;
-    multiple?: M | undefined;
-}) => Promise<M extends false | undefined ? File : File[]>;
-export declare const fileSave: (blob: Blob | Promise<Blob>, opts: {
-    /** supply without the extension */
-    name: string;
-    /** file extension */
-    extension: FILE_EXTENSION;
-    mimeTypes?: string[];
-    description: string;
-    /** existing FileSystemHandle */
-    fileHandle?: FileSystemHandle | null;
-}) => Promise<FileSystemHandle | null>;
-export { nativeFileSystemSupported };
-export type { FileSystemHandle };
+import { supported as nativeFileSystemSupported } from "browser-fs-access";
+import { MIME_TYPES } from "../constants";
+import type { FileSystemHandle } from "browser-fs-access";
+type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
+export declare const fileOpen: <M extends boolean | undefined = false>(opts: {
+    extensions?: FILE_EXTENSION[] | undefined;
+    description: string;
+    multiple?: M | undefined;
+}) => Promise<M extends false | undefined ? File : File[]>;
+export declare const fileSave: (blob: Blob | Promise<Blob>, opts: {
+    /** supply without the extension */
+    name: string;
+    /** file extension */
+    extension: FILE_EXTENSION;
+    mimeTypes?: string[];
+    description: string;
+    /** existing FileSystemHandle */
+    fileHandle?: FileSystemHandle | null;
+}) => Promise<FileSystemHandle | null>;
+export { nativeFileSystemSupported };
+export type { FileSystemHandle };

package/types/excalidraw/data/image.d.ts

@@ -1,9 +1,9 @@
-export declare const getTEXtChunk: (blob: Blob) => Promise<{
-    keyword: string;
-    text: string;
-} | null>;
-export declare const encodePngMetadata: ({ blob, metadata, }: {
-    blob: Blob;
-    metadata: string;
-}) => Promise<Blob>;
-export declare const decodePngMetadata: (blob: Blob) => Promise<string>;
+export declare const getTEXtChunk: (blob: Blob) => Promise<{
+    keyword: string;
+    text: string;
+} | null>;
+export declare const encodePngMetadata: ({ blob, metadata, }: {
+    blob: Blob;
+    metadata: string;
+}) => Promise<Blob>;
+export declare const decodePngMetadata: (blob: Blob) => Promise<string>;

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

@@ -1,22 +1,22 @@
-import type { ExcalidrawElement, ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "../element/types";
-import type { ExportType } from "../scene/types";
-import type { AppState, BinaryFiles } from "../types";
-import type { FileSystemHandle } from "./filesystem";
-export { loadFromBlob } from "./blob";
-export { loadFromJSON, saveAsJSON } from "./json";
-export type ExportedElements = readonly NonDeletedExcalidrawElement[] & {
-    _brand: "exportedElements";
-};
-export declare const prepareElementsForExport: (elements: readonly ExcalidrawElement[], { selectedElementIds }: Pick<AppState, "selectedElementIds">, exportSelectionOnly: boolean) => {
-    exportingFrame: ExcalidrawFrameLikeElement | null;
-    exportedElements: ExportedElements;
-};
-export declare const exportCanvas: (type: Omit<ExportType, "backend">, elements: ExportedElements, appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, name, fileHandle, exportingFrame, }: {
-    exportBackground: boolean;
-    exportPadding?: number | undefined;
-    viewBackgroundColor: string;
-    /** filename, if applicable */
-    name?: string | undefined;
-    fileHandle?: FileSystemHandle | null | undefined;
-    exportingFrame: ExcalidrawFrameLikeElement | null;
-}) => Promise<FileSystemHandle | null | undefined>;
+import type { FileSystemHandle } from "./filesystem";
+import type { ExcalidrawElement, ExcalidrawFrameLikeElement, NonDeletedExcalidrawElement } from "../element/types";
+import type { ExportType } from "../scene/types";
+import type { AppState, BinaryFiles } from "../types";
+export { loadFromBlob } from "./blob";
+export { loadFromJSON, saveAsJSON } from "./json";
+export type ExportedElements = readonly NonDeletedExcalidrawElement[] & {
+    _brand: "exportedElements";
+};
+export declare const prepareElementsForExport: (elements: readonly ExcalidrawElement[], { selectedElementIds }: Pick<AppState, "selectedElementIds">, exportSelectionOnly: boolean) => {
+    exportingFrame: ExcalidrawFrameLikeElement | null;
+    exportedElements: ExportedElements;
+};
+export declare const exportCanvas: (type: Omit<ExportType, "backend">, elements: ExportedElements, appState: AppState, files: BinaryFiles, { exportBackground, exportPadding, viewBackgroundColor, name, fileHandle, exportingFrame, }: {
+    exportBackground: boolean;
+    exportPadding?: number | undefined;
+    viewBackgroundColor: string;
+    /** filename, if applicable */
+    name?: string | undefined;
+    fileHandle?: FileSystemHandle | null | undefined;
+    exportingFrame: ExcalidrawFrameLikeElement | null;
+}) => Promise<FileSystemHandle | null | undefined>;

package/types/excalidraw/data/json.d.ts

@@ -1,16 +1,16 @@
-import type { ExcalidrawElement } from "../element/types";
-import type { AppState, BinaryFiles, LibraryItems } from "../types";
-import type { 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, name?: string) => 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 type { ExcalidrawElement } from "../element/types";
+import type { AppState, BinaryFiles, LibraryItems } from "../types";
+import type { 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, name?: string) => 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/excalidraw/data/library.d.ts

@@ -1,112 +1,112 @@
-import type { LibraryItems, ExcalidrawImperativeAPI, LibraryItemsSource, LibraryItems_anyVersion } from "../types";
-import type App from "../components/App";
-import type { ExcalidrawElement } from "../element/types";
-import type { MaybePromise } from "../utility-types";
-export type LibraryPersistedData = {
-    libraryItems: LibraryItems;
-};
-export type LibraryAdatapterSource = "load" | "save";
-export interface LibraryPersistenceAdapter {
-    /**
-     * Should load data that were previously saved into the database using the
-     * `save` method. Should throw if saving fails.
-     *
-     * Will be used internally in multiple places, such as during save to
-     * in order to reconcile changes with latest store data.
-     */
-    load(metadata: {
-        /**
-         * Indicates whether we're loading data for save purposes, or reading
-         * purposes, in which case host app can implement more aggressive caching.
-         */
-        source: LibraryAdatapterSource;
-    }): MaybePromise<{
-        libraryItems: LibraryItems_anyVersion;
-    } | null>;
-    /** Should persist to the database as is (do no change the data structure). */
-    save(libraryData: LibraryPersistedData): MaybePromise<void>;
-}
-export interface LibraryMigrationAdapter {
-    /**
-     * loads data from legacy data source. Returns `null` if no data is
-     * to be migrated.
-     */
-    load(): MaybePromise<{
-        libraryItems: LibraryItems_anyVersion;
-    } | null>;
-    /** clears entire storage afterwards */
-    clear(): MaybePromise<void>;
-}
-export declare const libraryItemsAtom: import("jotai/vanilla/atom").PrimitiveAtom<{
-    status: "loading" | "loaded";
-    /** indicates whether library is initialized with library items (has gone
-     * through at least one update). Used in UI. Specific to this atom only. */
-    isInitialized: boolean;
-    libraryItems: LibraryItems;
-}> & {
-    init: {
-        status: "loading" | "loaded";
-        /** indicates whether library is initialized with library items (has gone
-         * through at least one update). Used in UI. Specific to this atom only. */
-        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 currLibraryItems;
-    /** snapshot of library items since last onLibraryChange call */
-    private prevLibraryItems;
-    private app;
-    constructor(app: App);
-    private updateQueue;
-    private getLastUpdateTask;
-    private notifyListeners;
-    /** call on excalidraw instance unmount */
-    destroy: () => void;
-    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 validateLibraryUrl: (libraryUrl: string, validator?: string[] | ((libraryUrl: string) => boolean)) => true;
-export declare const parseLibraryTokensFromUrl: () => {
-    libraryUrl: string;
-    idToken: string | null;
-} | null;
-export declare const getLibraryItemsHash: (items: LibraryItems) => number;
-export declare const useHandleLibrary: (opts: {
-    excalidrawAPI: ExcalidrawImperativeAPI | null;
-    /**
-     * Return `true` if the library install url should be allowed.
-     * If not supplied, only the excalidraw.com base domain is allowed.
-     */
-    validateLibraryUrl?: ((libraryUrl: string) => boolean) | undefined;
-} & ({
-    /** @deprecated we recommend using `opts.adapter` instead */
-    getInitialLibraryItems?: (() => MaybePromise<LibraryItemsSource>) | undefined;
-} | {
-    adapter: LibraryPersistenceAdapter;
-    /**
-     * Adapter that takes care of loading data from legacy data store.
-     * Supply this if you want to migrate data on initial load from legacy
-     * data store.
-     *
-     * Can be a different LibraryPersistenceAdapter.
-     */
-    migrationAdapter?: LibraryMigrationAdapter | undefined;
-})) => void;
+import type App from "../components/App";
+import type { ExcalidrawElement } from "../element/types";
+import type { LibraryItems, ExcalidrawImperativeAPI, LibraryItemsSource, LibraryItems_anyVersion } from "../types";
+import type { MaybePromise } from "../utility-types";
+export type LibraryPersistedData = {
+    libraryItems: LibraryItems;
+};
+export type LibraryAdatapterSource = "load" | "save";
+export interface LibraryPersistenceAdapter {
+    /**
+     * Should load data that were previously saved into the database using the
+     * `save` method. Should throw if saving fails.
+     *
+     * Will be used internally in multiple places, such as during save to
+     * in order to reconcile changes with latest store data.
+     */
+    load(metadata: {
+        /**
+         * Indicates whether we're loading data for save purposes, or reading
+         * purposes, in which case host app can implement more aggressive caching.
+         */
+        source: LibraryAdatapterSource;
+    }): MaybePromise<{
+        libraryItems: LibraryItems_anyVersion;
+    } | null>;
+    /** Should persist to the database as is (do no change the data structure). */
+    save(libraryData: LibraryPersistedData): MaybePromise<void>;
+}
+export interface LibraryMigrationAdapter {
+    /**
+     * loads data from legacy data source. Returns `null` if no data is
+     * to be migrated.
+     */
+    load(): MaybePromise<{
+        libraryItems: LibraryItems_anyVersion;
+    } | null>;
+    /** clears entire storage afterwards */
+    clear(): MaybePromise<void>;
+}
+export declare const libraryItemsAtom: import("jotai/vanilla/atom").PrimitiveAtom<{
+    status: "loading" | "loaded";
+    /** indicates whether library is initialized with library items (has gone
+     * through at least one update). Used in UI. Specific to this atom only. */
+    isInitialized: boolean;
+    libraryItems: LibraryItems;
+}> & {
+    init: {
+        status: "loading" | "loaded";
+        /** indicates whether library is initialized with library items (has gone
+         * through at least one update). Used in UI. Specific to this atom only. */
+        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 currLibraryItems;
+    /** snapshot of library items since last onLibraryChange call */
+    private prevLibraryItems;
+    private app;
+    constructor(app: App);
+    private updateQueue;
+    private getLastUpdateTask;
+    private notifyListeners;
+    /** call on excalidraw instance unmount */
+    destroy: () => void;
+    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?: "unpublished" | "published" | 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 validateLibraryUrl: (libraryUrl: string, validator?: string[] | ((libraryUrl: string) => boolean)) => true;
+export declare const parseLibraryTokensFromUrl: () => {
+    libraryUrl: string;
+    idToken: string | null;
+} | null;
+export declare const getLibraryItemsHash: (items: LibraryItems) => number;
+export declare const useHandleLibrary: (opts: {
+    excalidrawAPI: ExcalidrawImperativeAPI | null;
+    /**
+     * Return `true` if the library install url should be allowed.
+     * If not supplied, only the excalidraw.com base domain is allowed.
+     */
+    validateLibraryUrl?: ((libraryUrl: string) => boolean) | undefined;
+} & ({
+    /** @deprecated we recommend using `opts.adapter` instead */
+    getInitialLibraryItems?: (() => MaybePromise<LibraryItemsSource>) | undefined;
+} | {
+    adapter: LibraryPersistenceAdapter;
+    /**
+     * Adapter that takes care of loading data from legacy data store.
+     * Supply this if you want to migrate data on initial load from legacy
+     * data store.
+     *
+     * Can be a different LibraryPersistenceAdapter.
+     */
+    migrationAdapter?: LibraryMigrationAdapter | undefined;
+})) => void;

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

@@ -1,6 +1,6 @@
-import type { OrderedExcalidrawElement } from "../element/types";
-import type { AppState } from "../types";
-import type { MakeBrand } from "../utility-types";
-export type ReconciledExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"ReconciledElement">;
-export type RemoteExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"RemoteExcalidrawElement">;
-export declare const reconcileElements: (localElements: readonly OrderedExcalidrawElement[], remoteElements: readonly RemoteExcalidrawElement[], localAppState: AppState) => ReconciledExcalidrawElement[];
+import type { OrderedExcalidrawElement } from "../element/types";
+import type { AppState } from "../types";
+import type { MakeBrand } from "../utility-types";
+export type ReconciledExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"ReconciledElement">;
+export type RemoteExcalidrawElement = OrderedExcalidrawElement & MakeBrand<"RemoteExcalidrawElement">;
+export declare const reconcileElements: (localElements: readonly OrderedExcalidrawElement[], remoteElements: readonly RemoteExcalidrawElement[], localAppState: AppState) => ReconciledExcalidrawElement[];

package/types/excalidraw/data/resave.d.ts

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