Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c9f62f20d5 | |||
| 21dd1cfacc | |||
| fa1f7d9f22 | |||
| 3d8c12fba4 | |||
| 757dfeb6ad | |||
| a0e93b6040 | |||
| 499e9d64a5 | |||
| c1dbbdf678 | |||
| 47c254216b | |||
| d1cff91b75 | |||
| 437595fa65 | |||
| 60b275880d | |||
| cae9d2bcbd | |||
| 2874f9e48c | |||
| 0b3a5e7cc4 | |||
| 7ea3229e17 | |||
| b0404b10b6 | |||
| eb959128ac |
+22
-1
@@ -39,5 +39,26 @@
|
|||||||
"allowReferrer": true
|
"allowReferrer": true
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
},
|
||||||
|
"overrides": [
|
||||||
|
{
|
||||||
|
"files": ["packages/excalidraw/**/*.{ts,tsx}"],
|
||||||
|
"excludedFiles": ["packages/excalidraw/**/*.test.{ts,tsx}", "packages/excalidraw/**/*.test.*.{ts,tsx}"],
|
||||||
|
"rules": {
|
||||||
|
"@typescript-eslint/no-restricted-imports": [
|
||||||
|
"error",
|
||||||
|
{
|
||||||
|
"patterns": [
|
||||||
|
{
|
||||||
|
"group": ["@excalidraw/excalidraw"],
|
||||||
|
"message": "Do not import from the barrel 'index.tsx' files. Use direct relative imports to the specific module instead.",
|
||||||
|
"allowTypeImports": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"paths": [".", "..", "../..", "../../..", "../../../..", "../../../../..", "../index", "../../index", "../../../index", "../../../../index"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,14 +3,14 @@
|
|||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"react": "19.0.0",
|
|
||||||
"react-dom": "19.0.0",
|
|
||||||
"@excalidraw/excalidraw": "*",
|
"@excalidraw/excalidraw": "*",
|
||||||
"browser-fs-access": "0.29.1"
|
"browser-fs-access": "0.38.0",
|
||||||
|
"react": "19.0.0",
|
||||||
|
"react-dom": "19.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vite": "5.0.12",
|
"typescript": "^5",
|
||||||
"typescript": "^5"
|
"vite": "5.0.12"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "vite",
|
"start": "vite",
|
||||||
|
|||||||
@@ -4,8 +4,6 @@ import { unstable_batchedUpdates } from "react-dom";
|
|||||||
|
|
||||||
type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
|
type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
|
||||||
|
|
||||||
const INPUT_CHANGE_INTERVAL_MS = 500;
|
|
||||||
|
|
||||||
export type ResolvablePromise<T> = Promise<T> & {
|
export type ResolvablePromise<T> = Promise<T> & {
|
||||||
resolve: [T] extends [undefined] ? (value?: T) => void : (value: T) => void;
|
resolve: [T] extends [undefined] ? (value?: T) => void : (value: T) => void;
|
||||||
reject: (error: Error) => void;
|
reject: (error: Error) => void;
|
||||||
@@ -54,40 +52,6 @@ export const fileOpen = <M extends boolean | undefined = false>(opts: {
|
|||||||
extensions,
|
extensions,
|
||||||
mimeTypes,
|
mimeTypes,
|
||||||
multiple: opts.multiple ?? false,
|
multiple: opts.multiple ?? false,
|
||||||
legacySetup: (resolve, reject, input) => {
|
|
||||||
const scheduleRejection = debounce(reject, INPUT_CHANGE_INTERVAL_MS);
|
|
||||||
const focusHandler = () => {
|
|
||||||
checkForFile();
|
|
||||||
document.addEventListener("keyup", scheduleRejection);
|
|
||||||
document.addEventListener("pointerup", scheduleRejection);
|
|
||||||
scheduleRejection();
|
|
||||||
};
|
|
||||||
const checkForFile = () => {
|
|
||||||
// this hack might not work when expecting multiple files
|
|
||||||
if (input.files?.length) {
|
|
||||||
const ret = opts.multiple ? [...input.files] : input.files[0];
|
|
||||||
resolve(ret as RetType);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
requestAnimationFrame(() => {
|
|
||||||
window.addEventListener("focus", focusHandler);
|
|
||||||
});
|
|
||||||
const interval = window.setInterval(() => {
|
|
||||||
checkForFile();
|
|
||||||
}, INPUT_CHANGE_INTERVAL_MS);
|
|
||||||
return (rejectPromise) => {
|
|
||||||
clearInterval(interval);
|
|
||||||
scheduleRejection.cancel();
|
|
||||||
window.removeEventListener("focus", focusHandler);
|
|
||||||
document.removeEventListener("keyup", scheduleRejection);
|
|
||||||
document.removeEventListener("pointerup", scheduleRejection);
|
|
||||||
if (rejectPromise) {
|
|
||||||
// so that something is shown in console if we need to debug this
|
|
||||||
console.warn("Opening the file was canceled (legacy-fs).");
|
|
||||||
rejectPromise(new Error("Request Aborted"));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
},
|
|
||||||
}) as Promise<RetType>;
|
}) as Promise<RetType>;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
+94
-26
@@ -5,6 +5,8 @@ import {
|
|||||||
CaptureUpdateAction,
|
CaptureUpdateAction,
|
||||||
reconcileElements,
|
reconcileElements,
|
||||||
useEditorInterface,
|
useEditorInterface,
|
||||||
|
ExcalidrawAPIProvider,
|
||||||
|
useExcalidrawAPI,
|
||||||
} from "@excalidraw/excalidraw";
|
} from "@excalidraw/excalidraw";
|
||||||
import { trackEvent } from "@excalidraw/excalidraw/analytics";
|
import { trackEvent } from "@excalidraw/excalidraw/analytics";
|
||||||
import { getDefaultAppState } from "@excalidraw/excalidraw/appState";
|
import { getDefaultAppState } from "@excalidraw/excalidraw/appState";
|
||||||
@@ -34,7 +36,6 @@ import {
|
|||||||
import polyfill from "@excalidraw/excalidraw/polyfill";
|
import polyfill from "@excalidraw/excalidraw/polyfill";
|
||||||
import { useCallback, useEffect, useRef, useState } from "react";
|
import { useCallback, useEffect, useRef, useState } from "react";
|
||||||
import { loadFromBlob } from "@excalidraw/excalidraw/data/blob";
|
import { loadFromBlob } from "@excalidraw/excalidraw/data/blob";
|
||||||
import { useCallbackRefState } from "@excalidraw/excalidraw/hooks/useCallbackRefState";
|
|
||||||
import { t } from "@excalidraw/excalidraw/i18n";
|
import { t } from "@excalidraw/excalidraw/i18n";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
@@ -74,6 +75,7 @@ import type {
|
|||||||
BinaryFiles,
|
BinaryFiles,
|
||||||
ExcalidrawInitialDataState,
|
ExcalidrawInitialDataState,
|
||||||
UIAppState,
|
UIAppState,
|
||||||
|
ExcalidrawProps,
|
||||||
} from "@excalidraw/excalidraw/types";
|
} from "@excalidraw/excalidraw/types";
|
||||||
import type { ResolutionType } from "@excalidraw/common/utility-types";
|
import type { ResolutionType } from "@excalidraw/common/utility-types";
|
||||||
import type { ResolvablePromise } from "@excalidraw/common/utils";
|
import type { ResolvablePromise } from "@excalidraw/common/utils";
|
||||||
@@ -114,6 +116,7 @@ import {
|
|||||||
} from "./data";
|
} from "./data";
|
||||||
|
|
||||||
import { updateStaleImageStatuses } from "./data/FileManager";
|
import { updateStaleImageStatuses } from "./data/FileManager";
|
||||||
|
import { FileStatusStore } from "./data/fileStatusStore";
|
||||||
import {
|
import {
|
||||||
importFromLocalStorage,
|
importFromLocalStorage,
|
||||||
importUsernameFromLocalStorage,
|
importUsernameFromLocalStorage,
|
||||||
@@ -266,7 +269,7 @@ const initializeScene = async (opts: {
|
|||||||
repairBindings: true,
|
repairBindings: true,
|
||||||
deleteInvisibleElements: true,
|
deleteInvisibleElements: true,
|
||||||
}),
|
}),
|
||||||
scene.elements,
|
localDataState?.elements,
|
||||||
),
|
),
|
||||||
appState: restoreAppState(
|
appState: restoreAppState(
|
||||||
imported.appState,
|
imported.appState,
|
||||||
@@ -369,6 +372,8 @@ const initializeScene = async (opts: {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const ExcalidrawWrapper = () => {
|
const ExcalidrawWrapper = () => {
|
||||||
|
const excalidrawAPI = useExcalidrawAPI();
|
||||||
|
|
||||||
const [errorMessage, setErrorMessage] = useState("");
|
const [errorMessage, setErrorMessage] = useState("");
|
||||||
const isCollabDisabled = isRunningInIframe();
|
const isCollabDisabled = isRunningInIframe();
|
||||||
|
|
||||||
@@ -399,9 +404,6 @@ const ExcalidrawWrapper = () => {
|
|||||||
}, VERSION_TIMEOUT);
|
}, VERSION_TIMEOUT);
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const [excalidrawAPI, excalidrawRefCallback] =
|
|
||||||
useCallbackRefState<ExcalidrawImperativeAPI>();
|
|
||||||
|
|
||||||
const [, setShareDialogState] = useAtom(shareDialogStateAtom);
|
const [, setShareDialogState] = useAtom(shareDialogStateAtom);
|
||||||
const [collabAPI] = useAtom(collabAPIAtom);
|
const [collabAPI] = useAtom(collabAPIAtom);
|
||||||
const [isCollaborating] = useAtomWithInitialValue(isCollaboratingAtom, () => {
|
const [isCollaborating] = useAtomWithInitialValue(isCollaboratingAtom, () => {
|
||||||
@@ -433,18 +435,15 @@ const ExcalidrawWrapper = () => {
|
|||||||
}
|
}
|
||||||
}, [excalidrawAPI]);
|
}, [excalidrawAPI]);
|
||||||
|
|
||||||
useEffect(() => {
|
// ---------------------------------------------------------------------------
|
||||||
if (!excalidrawAPI || (!isCollabDisabled && !collabAPI)) {
|
// Hoisted loadImages
|
||||||
return;
|
// ---------------------------------------------------------------------------
|
||||||
}
|
const loadImages = useCallback(
|
||||||
|
(data: ResolutionType<typeof initializeScene>, isInitialLoad = false) => {
|
||||||
const loadImages = (
|
if (!data.scene || !excalidrawAPI) {
|
||||||
data: ResolutionType<typeof initializeScene>,
|
|
||||||
isInitialLoad = false,
|
|
||||||
) => {
|
|
||||||
if (!data.scene) {
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (collabAPI?.isCollaborating()) {
|
if (collabAPI?.isCollaborating()) {
|
||||||
if (data.scene.elements) {
|
if (data.scene.elements) {
|
||||||
collabAPI
|
collabAPI
|
||||||
@@ -471,6 +470,12 @@ const ExcalidrawWrapper = () => {
|
|||||||
}, [] as FileId[]) || [];
|
}, [] as FileId[]) || [];
|
||||||
|
|
||||||
if (data.isExternalScene) {
|
if (data.isExternalScene) {
|
||||||
|
if (fileIds.length) {
|
||||||
|
// Direct Firebase call (not through FileManager), so track manually
|
||||||
|
FileStatusStore.updateStatuses(
|
||||||
|
fileIds.map((id) => [id, "loading"]),
|
||||||
|
);
|
||||||
|
}
|
||||||
loadFilesFromFirebase(
|
loadFilesFromFirebase(
|
||||||
`${FIREBASE_STORAGE_PREFIXES.shareLinkFiles}/${data.id}`,
|
`${FIREBASE_STORAGE_PREFIXES.shareLinkFiles}/${data.id}`,
|
||||||
data.key,
|
data.key,
|
||||||
@@ -482,12 +487,18 @@ const ExcalidrawWrapper = () => {
|
|||||||
erroredFiles,
|
erroredFiles,
|
||||||
elements: excalidrawAPI.getSceneElementsIncludingDeleted(),
|
elements: excalidrawAPI.getSceneElementsIncludingDeleted(),
|
||||||
});
|
});
|
||||||
|
FileStatusStore.updateStatuses([
|
||||||
|
...loadedFiles.map((f) => [f.id, "loaded"] as [FileId, "loaded"]),
|
||||||
|
...[...erroredFiles.keys()].map(
|
||||||
|
(id) => [id, "error"] as [FileId, "error"],
|
||||||
|
),
|
||||||
|
]);
|
||||||
});
|
});
|
||||||
} else if (isInitialLoad) {
|
} else if (isInitialLoad) {
|
||||||
if (fileIds.length) {
|
if (fileIds.length) {
|
||||||
LocalData.fileStorage
|
LocalData.fileStorage
|
||||||
.getFiles(fileIds)
|
.getFiles(fileIds)
|
||||||
.then(({ loadedFiles, erroredFiles }) => {
|
.then(async ({ loadedFiles, erroredFiles }) => {
|
||||||
if (loadedFiles.length) {
|
if (loadedFiles.length) {
|
||||||
excalidrawAPI.addFiles(loadedFiles);
|
excalidrawAPI.addFiles(loadedFiles);
|
||||||
}
|
}
|
||||||
@@ -500,10 +511,19 @@ const ExcalidrawWrapper = () => {
|
|||||||
}
|
}
|
||||||
// on fresh load, clear unused files from IDB (from previous
|
// on fresh load, clear unused files from IDB (from previous
|
||||||
// session)
|
// session)
|
||||||
LocalData.fileStorage.clearObsoleteFiles({ currentFileIds: fileIds });
|
LocalData.fileStorage.clearObsoleteFiles({
|
||||||
|
currentFileIds: fileIds,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
},
|
||||||
|
[collabAPI, excalidrawAPI],
|
||||||
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!excalidrawAPI || (!isCollabDisabled && !collabAPI)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
initializeScene({ collabAPI, excalidrawAPI }).then(async (data) => {
|
initializeScene({ collabAPI, excalidrawAPI }).then(async (data) => {
|
||||||
loadImages(data, /* isInitialLoad */ true);
|
loadImages(data, /* isInitialLoad */ true);
|
||||||
@@ -551,11 +571,7 @@ const ExcalidrawWrapper = () => {
|
|||||||
const username = importUsernameFromLocalStorage();
|
const username = importUsernameFromLocalStorage();
|
||||||
setLangCode(getPreferredLanguage());
|
setLangCode(getPreferredLanguage());
|
||||||
excalidrawAPI.updateScene({
|
excalidrawAPI.updateScene({
|
||||||
elements: restoreElements(localDataState?.elements, null, {
|
...localDataState,
|
||||||
repairBindings: true,
|
|
||||||
deleteInvisibleElements: true,
|
|
||||||
}),
|
|
||||||
appState: restoreAppState(localDataState?.appState, null),
|
|
||||||
captureUpdate: CaptureUpdateAction.NEVER,
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
});
|
});
|
||||||
LibraryIndexedDBAdapter.load().then((data) => {
|
LibraryIndexedDBAdapter.load().then((data) => {
|
||||||
@@ -632,7 +648,7 @@ const ExcalidrawWrapper = () => {
|
|||||||
false,
|
false,
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
}, [isCollabDisabled, collabAPI, excalidrawAPI, setLangCode]);
|
}, [isCollabDisabled, collabAPI, excalidrawAPI, setLangCode, loadImages]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const unloadHandler = (event: BeforeUnloadEvent) => {
|
const unloadHandler = (event: BeforeUnloadEvent) => {
|
||||||
@@ -777,6 +793,56 @@ const ExcalidrawWrapper = () => {
|
|||||||
[setShareDialogState],
|
[setShareDialogState],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// onExport — intercepts file save to wait for pending image loads
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
const onExport: Required<ExcalidrawProps>["onExport"] = useCallback(
|
||||||
|
async function* () {
|
||||||
|
let snapshot = FileStatusStore.getSnapshot();
|
||||||
|
const { pending, total } = FileStatusStore.getPendingCount(
|
||||||
|
snapshot.value,
|
||||||
|
);
|
||||||
|
if (pending === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Yield initial progress
|
||||||
|
yield {
|
||||||
|
type: "progress",
|
||||||
|
progress: (total - pending) / total,
|
||||||
|
message: `Loading images (${total - pending}/${total})...`,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Wait for all pending images to finish
|
||||||
|
while (true) {
|
||||||
|
snapshot = await FileStatusStore.pull(snapshot.version);
|
||||||
|
const { pending: nowPending, total: nowTotal } =
|
||||||
|
FileStatusStore.getPendingCount(snapshot.value);
|
||||||
|
|
||||||
|
yield {
|
||||||
|
type: "progress",
|
||||||
|
progress: (nowTotal - nowPending) / nowTotal,
|
||||||
|
message: `Loading images (${nowTotal - nowPending}/${nowTotal})...`,
|
||||||
|
};
|
||||||
|
|
||||||
|
if (nowPending === 0) {
|
||||||
|
await new Promise((r) => setTimeout(r, 500));
|
||||||
|
yield {
|
||||||
|
type: "progress",
|
||||||
|
message: `Preparing export...`,
|
||||||
|
};
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
|
||||||
|
// const onExport = () => {
|
||||||
|
// return new Promise((r) => setTimeout(r, 2500));
|
||||||
|
// // console.log("onExport");
|
||||||
|
// };
|
||||||
|
|
||||||
// browsers generally prevent infinite self-embedding, there are
|
// browsers generally prevent infinite self-embedding, there are
|
||||||
// cases where it still happens, and while we disallow self-embedding
|
// cases where it still happens, and while we disallow self-embedding
|
||||||
// by not whitelisting our own origin, this serves as an additional guard
|
// by not whitelisting our own origin, this serves as an additional guard
|
||||||
@@ -843,8 +909,8 @@ const ExcalidrawWrapper = () => {
|
|||||||
})}
|
})}
|
||||||
>
|
>
|
||||||
<Excalidraw
|
<Excalidraw
|
||||||
excalidrawAPI={excalidrawRefCallback}
|
|
||||||
onChange={onChange}
|
onChange={onChange}
|
||||||
|
onExport={onExport}
|
||||||
initialData={initialStatePromiseRef.current.promise}
|
initialData={initialStatePromiseRef.current.promise}
|
||||||
isCollaborating={isCollaborating}
|
isCollaborating={isCollaborating}
|
||||||
onPointerUpdate={collabAPI?.onPointerUpdate}
|
onPointerUpdate={collabAPI?.onPointerUpdate}
|
||||||
@@ -1210,7 +1276,9 @@ const ExcalidrawApp = () => {
|
|||||||
return (
|
return (
|
||||||
<TopErrorBoundary>
|
<TopErrorBoundary>
|
||||||
<Provider store={appJotaiStore}>
|
<Provider store={appJotaiStore}>
|
||||||
<ExcalidrawWrapper />
|
<ExcalidrawAPIProvider>
|
||||||
|
<ExcalidrawWrapper />
|
||||||
|
</ExcalidrawAPIProvider>
|
||||||
</Provider>
|
</Provider>
|
||||||
</TopErrorBoundary>
|
</TopErrorBoundary>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -72,6 +72,7 @@ import {
|
|||||||
FileManager,
|
FileManager,
|
||||||
updateStaleImageStatuses,
|
updateStaleImageStatuses,
|
||||||
} from "../data/FileManager";
|
} from "../data/FileManager";
|
||||||
|
import { FileStatusStore } from "../data/fileStatusStore";
|
||||||
import { LocalData } from "../data/LocalData";
|
import { LocalData } from "../data/LocalData";
|
||||||
import {
|
import {
|
||||||
isSavedToFirebase,
|
isSavedToFirebase,
|
||||||
@@ -149,6 +150,7 @@ class Collab extends PureComponent<CollabProps, CollabState> {
|
|||||||
};
|
};
|
||||||
this.portal = new Portal(this);
|
this.portal = new Portal(this);
|
||||||
this.fileManager = new FileManager({
|
this.fileManager = new FileManager({
|
||||||
|
onFileStatusChange: FileStatusStore.updateStatuses.bind(FileStatusStore),
|
||||||
getFiles: async (fileIds) => {
|
getFiles: async (fileIds) => {
|
||||||
const { roomId, roomKey } = this.portal;
|
const { roomId, roomKey } = this.portal;
|
||||||
if (!roomId || !roomKey) {
|
if (!roomId || !roomKey) {
|
||||||
|
|||||||
@@ -414,7 +414,6 @@ export const debugRenderer = throttleRAF(
|
|||||||
) => {
|
) => {
|
||||||
_debugRenderer(canvas, appState, elements, scale);
|
_debugRenderer(canvas, appState, elements, scale);
|
||||||
},
|
},
|
||||||
{ trailing: true },
|
|
||||||
);
|
);
|
||||||
|
|
||||||
export const loadSavedDebugState = () => {
|
export const loadSavedDebugState = () => {
|
||||||
|
|||||||
@@ -40,10 +40,12 @@ export class FileManager {
|
|||||||
|
|
||||||
private _getFiles;
|
private _getFiles;
|
||||||
private _saveFiles;
|
private _saveFiles;
|
||||||
|
private _onFileStatusChange;
|
||||||
|
|
||||||
constructor({
|
constructor({
|
||||||
getFiles,
|
getFiles,
|
||||||
saveFiles,
|
saveFiles,
|
||||||
|
onFileStatusChange,
|
||||||
}: {
|
}: {
|
||||||
getFiles: (fileIds: FileId[]) => Promise<{
|
getFiles: (fileIds: FileId[]) => Promise<{
|
||||||
loadedFiles: BinaryFileData[];
|
loadedFiles: BinaryFileData[];
|
||||||
@@ -53,9 +55,13 @@ export class FileManager {
|
|||||||
savedFiles: Map<FileId, BinaryFileData>;
|
savedFiles: Map<FileId, BinaryFileData>;
|
||||||
erroredFiles: Map<FileId, BinaryFileData>;
|
erroredFiles: Map<FileId, BinaryFileData>;
|
||||||
}>;
|
}>;
|
||||||
|
onFileStatusChange?: (
|
||||||
|
updates: Array<[FileId, "loading" | "loaded" | "error"]>,
|
||||||
|
) => void;
|
||||||
}) {
|
}) {
|
||||||
this._getFiles = getFiles;
|
this._getFiles = getFiles;
|
||||||
this._saveFiles = saveFiles;
|
this._saveFiles = saveFiles;
|
||||||
|
this._onFileStatusChange = onFileStatusChange;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -146,6 +152,8 @@ export class FileManager {
|
|||||||
this.fetchingFiles.set(id, true);
|
this.fetchingFiles.set(id, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this._onFileStatusChange?.(ids.map((id) => [id, "loading"]));
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { loadedFiles, erroredFiles } = await this._getFiles(ids);
|
const { loadedFiles, erroredFiles } = await this._getFiles(ids);
|
||||||
|
|
||||||
@@ -156,6 +164,13 @@ export class FileManager {
|
|||||||
this.erroredFiles_fetch.set(fileId, true);
|
this.erroredFiles_fetch.set(fileId, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this._onFileStatusChange?.([
|
||||||
|
...loadedFiles.map((f) => [f.id, "loaded"] as [FileId, "loaded"]),
|
||||||
|
...[...erroredFiles.keys()].map(
|
||||||
|
(id) => [id, "error"] as [FileId, "error"],
|
||||||
|
),
|
||||||
|
]);
|
||||||
|
|
||||||
return { loadedFiles, erroredFiles };
|
return { loadedFiles, erroredFiles };
|
||||||
} finally {
|
} finally {
|
||||||
for (const id of ids) {
|
for (const id of ids) {
|
||||||
@@ -195,6 +210,13 @@ export class FileManager {
|
|||||||
};
|
};
|
||||||
|
|
||||||
reset() {
|
reset() {
|
||||||
|
if (this._onFileStatusChange && this.fetchingFiles.size) {
|
||||||
|
this._onFileStatusChange(
|
||||||
|
[...this.fetchingFiles.keys()].map(
|
||||||
|
(id) => [id, "error"] as [FileId, "error"],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
this.fetchingFiles.clear();
|
this.fetchingFiles.clear();
|
||||||
this.savingFiles.clear();
|
this.savingFiles.clear();
|
||||||
this.savedFiles.clear();
|
this.savedFiles.clear();
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ import type { MaybePromise } from "@excalidraw/common/utility-types";
|
|||||||
import { SAVE_TO_LOCAL_STORAGE_TIMEOUT, STORAGE_KEYS } from "../app_constants";
|
import { SAVE_TO_LOCAL_STORAGE_TIMEOUT, STORAGE_KEYS } from "../app_constants";
|
||||||
|
|
||||||
import { FileManager } from "./FileManager";
|
import { FileManager } from "./FileManager";
|
||||||
|
import { FileStatusStore } from "./fileStatusStore";
|
||||||
import { Locker } from "./Locker";
|
import { Locker } from "./Locker";
|
||||||
import { updateBrowserStateVersion } from "./tabSync";
|
import { updateBrowserStateVersion } from "./tabSync";
|
||||||
|
|
||||||
@@ -86,11 +87,9 @@ const saveDataStateToLocalStorage = (
|
|||||||
_appState.openSidebar = null;
|
_appState.openSidebar = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const persistedElements = getNonDeletedElements(elements);
|
|
||||||
|
|
||||||
localStorage.setItem(
|
localStorage.setItem(
|
||||||
STORAGE_KEYS.LOCAL_STORAGE_ELEMENTS,
|
STORAGE_KEYS.LOCAL_STORAGE_ELEMENTS,
|
||||||
JSON.stringify(persistedElements),
|
JSON.stringify(getNonDeletedElements(elements)),
|
||||||
);
|
);
|
||||||
localStorage.setItem(
|
localStorage.setItem(
|
||||||
STORAGE_KEYS.LOCAL_STORAGE_APP_STATE,
|
STORAGE_KEYS.LOCAL_STORAGE_APP_STATE,
|
||||||
@@ -168,6 +167,7 @@ export class LocalData {
|
|||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
static fileStorage = new LocalFileManager({
|
static fileStorage = new LocalFileManager({
|
||||||
|
onFileStatusChange: FileStatusStore.updateStatuses.bind(FileStatusStore),
|
||||||
getFiles(ids) {
|
getFiles(ids) {
|
||||||
return getMany(ids, filesStore).then(
|
return getMany(ids, filesStore).then(
|
||||||
async (filesData: (BinaryFileData | undefined)[]) => {
|
async (filesData: (BinaryFileData | undefined)[]) => {
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
import { VersionedSnapshotStore } from "@excalidraw/common";
|
||||||
|
|
||||||
|
import type { FileId } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
export type FileLoadingStatus = "loading" | "loaded" | "error";
|
||||||
|
|
||||||
|
export class FileStatusStore {
|
||||||
|
private static store = new VersionedSnapshotStore<
|
||||||
|
Map<FileId, FileLoadingStatus>
|
||||||
|
>(new Map());
|
||||||
|
|
||||||
|
static getSnapshot() {
|
||||||
|
return this.store.getSnapshot();
|
||||||
|
}
|
||||||
|
|
||||||
|
static pull(sinceVersion?: number) {
|
||||||
|
return this.store.pull(sinceVersion);
|
||||||
|
}
|
||||||
|
|
||||||
|
static updateStatuses(updates: Array<[FileId, FileLoadingStatus]>) {
|
||||||
|
if (!updates.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.store.update((prev) => {
|
||||||
|
let changed = false;
|
||||||
|
const next = new Map(prev);
|
||||||
|
for (const [id, status] of updates) {
|
||||||
|
if (next.get(id) !== status) {
|
||||||
|
next.set(id, status);
|
||||||
|
changed = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return changed ? next : prev;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
static getPendingCount(statuses: Map<FileId, FileLoadingStatus>) {
|
||||||
|
let pending = 0;
|
||||||
|
let total = 0;
|
||||||
|
for (const status of statuses.values()) {
|
||||||
|
total++;
|
||||||
|
if (status === "loading") {
|
||||||
|
pending++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { pending, total };
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -69,114 +69,6 @@ vi.mock("socket.io-client", () => {
|
|||||||
* i.e. multiplayer history tests could be a good first candidate, as we could test both history stacks simultaneously.
|
* i.e. multiplayer history tests could be a good first candidate, as we could test both history stacks simultaneously.
|
||||||
*/
|
*/
|
||||||
describe("collaboration", () => {
|
describe("collaboration", () => {
|
||||||
it("should preserve future element fields across collab reconciliation", async () => {
|
|
||||||
await render(<ExcalidrawApp />);
|
|
||||||
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
id: "A",
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
x: 0,
|
|
||||||
y: 0,
|
|
||||||
backgroundColor: "#ff0000",
|
|
||||||
});
|
|
||||||
|
|
||||||
const frameWithFutureFields = {
|
|
||||||
...frame,
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
...frame.schemaState.tracks,
|
|
||||||
"host.myapp.frame": 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
futureField: "keep-me",
|
|
||||||
} as typeof frame & {
|
|
||||||
schemaState: { tracks: Record<string, number> };
|
|
||||||
futureField: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
API.updateScene({
|
|
||||||
elements: [frameWithFutureFields],
|
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
|
||||||
});
|
|
||||||
|
|
||||||
await waitFor(() => {
|
|
||||||
expect((h.elements[0] as any).futureField).toBe("keep-me");
|
|
||||||
expect((h.elements[0] as any).schemaState).toEqual(
|
|
||||||
frameWithFutureFields.schemaState,
|
|
||||||
);
|
|
||||||
expect(h.elements[0].backgroundColor).toBe("#ff0000");
|
|
||||||
});
|
|
||||||
|
|
||||||
const remoteMovedFrame = newElementWith(h.elements[0] as any, {
|
|
||||||
x: 120,
|
|
||||||
y: 80,
|
|
||||||
});
|
|
||||||
|
|
||||||
const reconciled = (window.collab as any)._reconcileElements([
|
|
||||||
remoteMovedFrame,
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(reconciled[0]).toEqual(
|
|
||||||
expect.objectContaining({
|
|
||||||
x: 120,
|
|
||||||
y: 80,
|
|
||||||
backgroundColor: "#ff0000",
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
expect((reconciled[0] as any).futureField).toBe("keep-me");
|
|
||||||
expect((reconciled[0] as any).schemaState).toEqual(
|
|
||||||
frameWithFutureFields.schemaState,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should preserve future element fields on local edits before broadcast", async () => {
|
|
||||||
await render(<ExcalidrawApp />);
|
|
||||||
|
|
||||||
const rect = API.createElement({
|
|
||||||
type: "rectangle",
|
|
||||||
id: "A",
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
x: 0,
|
|
||||||
y: 0,
|
|
||||||
});
|
|
||||||
|
|
||||||
const rectWithFutureFields = {
|
|
||||||
...rect,
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
...rect.schemaState.tracks,
|
|
||||||
"host.myapp.rect": 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
futureField: { value: "keep-me" },
|
|
||||||
} as typeof rect & {
|
|
||||||
schemaState: { tracks: Record<string, number> };
|
|
||||||
futureField: { value: string };
|
|
||||||
};
|
|
||||||
|
|
||||||
API.updateScene({
|
|
||||||
elements: [rectWithFutureFields],
|
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
|
||||||
});
|
|
||||||
|
|
||||||
const locallyEdited = newElementWith(h.elements[0] as any, { x: 200 });
|
|
||||||
API.updateScene({
|
|
||||||
elements: [locallyEdited],
|
|
||||||
captureUpdate: CaptureUpdateAction.NEVER,
|
|
||||||
});
|
|
||||||
|
|
||||||
await waitFor(() => {
|
|
||||||
expect((h.elements[0] as any).futureField).toEqual({ value: "keep-me" });
|
|
||||||
expect((h.elements[0] as any).schemaState).toEqual(
|
|
||||||
rectWithFutureFields.schemaState,
|
|
||||||
);
|
|
||||||
expect(h.elements[0]).toEqual(expect.objectContaining({ x: 200 }));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should emit two ephemeral increments even though updates get batched", async () => {
|
it("should emit two ephemeral increments even though updates get batched", async () => {
|
||||||
const durableIncrements: DurableIncrement[] = [];
|
const durableIncrements: DurableIncrement[] = [];
|
||||||
const ephemeralIncrements: EphemeralIncrement[] = [];
|
const ephemeralIncrements: EphemeralIncrement[] = [];
|
||||||
@@ -191,18 +83,14 @@ describe("collaboration", () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Ensure this test starts from a deterministic scene regardless of previous
|
// eslint-disable-next-line dot-notation
|
||||||
// test state restored from persistence.
|
expect(h.store["scheduledMicroActions"].length).toBe(0);
|
||||||
API.updateScene({
|
expect(durableIncrements.length).toBe(0);
|
||||||
elements: [],
|
expect(ephemeralIncrements.length).toBe(0);
|
||||||
captureUpdate: CaptureUpdateAction.NEVER,
|
|
||||||
});
|
|
||||||
|
|
||||||
const durableBaseline = durableIncrements.length;
|
|
||||||
const ephemeralBaseline = ephemeralIncrements.length;
|
|
||||||
|
|
||||||
const rectProps = {
|
const rectProps = {
|
||||||
type: "rectangle",
|
type: "rectangle",
|
||||||
|
id: "A",
|
||||||
height: 200,
|
height: 200,
|
||||||
width: 100,
|
width: 100,
|
||||||
x: 0,
|
x: 0,
|
||||||
@@ -217,7 +105,8 @@ describe("collaboration", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
await waitFor(() => {
|
await waitFor(() => {
|
||||||
expect(durableIncrements.length).toBe(durableBaseline + 1);
|
// expect(commitSpy).toHaveBeenCalledTimes(1);
|
||||||
|
expect(durableIncrements.length).toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
// simulate two batched remote updates
|
// simulate two batched remote updates
|
||||||
@@ -241,13 +130,13 @@ describe("collaboration", () => {
|
|||||||
// altough the updates get batched,
|
// altough the updates get batched,
|
||||||
// we expect two ephemeral increments for each update,
|
// we expect two ephemeral increments for each update,
|
||||||
// and each such update should have the expected change
|
// and each such update should have the expected change
|
||||||
expect(ephemeralIncrements.length).toBe(ephemeralBaseline + 2);
|
expect(ephemeralIncrements.length).toBe(2);
|
||||||
expect(
|
expect(ephemeralIncrements[0].change.elements.A).toEqual(
|
||||||
ephemeralIncrements[ephemeralBaseline].change.elements[rect.id],
|
expect.objectContaining({ x: 100 }),
|
||||||
).toEqual(expect.objectContaining({ x: 100 }));
|
);
|
||||||
expect(
|
expect(ephemeralIncrements[1].change.elements.A).toEqual(
|
||||||
ephemeralIncrements[ephemeralBaseline + 1].change.elements[rect.id],
|
expect.objectContaining({ x: 200 }),
|
||||||
).toEqual(expect.objectContaining({ x: 200 }));
|
);
|
||||||
// eslint-disable-next-line dot-notation
|
// eslint-disable-next-line dot-notation
|
||||||
expect(h.store["scheduledMicroActions"].length).toBe(0);
|
expect(h.store["scheduledMicroActions"].length).toBe(0);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -106,6 +106,10 @@ export default defineConfig(({ mode }) => {
|
|||||||
if (id.includes("@excalidraw/mermaid-to-excalidraw")) {
|
if (id.includes("@excalidraw/mermaid-to-excalidraw")) {
|
||||||
return "mermaid-to-excalidraw";
|
return "mermaid-to-excalidraw";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (id.includes("@codemirror/") || id.includes("@lezer/")) {
|
||||||
|
return "codemirror.chunk";
|
||||||
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -150,6 +154,11 @@ export default defineConfig(({ mode }) => {
|
|||||||
"**/locales/**",
|
"**/locales/**",
|
||||||
"service-worker.js",
|
"service-worker.js",
|
||||||
"**/*.chunk-*.js",
|
"**/*.chunk-*.js",
|
||||||
|
// CodeMirrorEditor can't be assigned a `.chunk` name via
|
||||||
|
// manualChunks because Rollup would hoist shared deps (React)
|
||||||
|
// via a static import from the main bundle, defeating lazy
|
||||||
|
// loading. So we exclude it by name instead.
|
||||||
|
"**/CodeMirrorEditor-*.js",
|
||||||
],
|
],
|
||||||
runtimeCaching: [
|
runtimeCaching: [
|
||||||
{
|
{
|
||||||
@@ -189,7 +198,7 @@ export default defineConfig(({ mode }) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
urlPattern: new RegExp(".chunk-.+.js"),
|
urlPattern: new RegExp("(.chunk-.+|CodeMirrorEditor-.+)\\.js"),
|
||||||
handler: "CacheFirst",
|
handler: "CacheFirst",
|
||||||
options: {
|
options: {
|
||||||
cacheName: "chunk",
|
cacheName: "chunk",
|
||||||
|
|||||||
@@ -1,9 +1,3 @@
|
|||||||
declare global {
|
|
||||||
interface Window {
|
|
||||||
debug: typeof Debug;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const lessPrecise = (num: number, precision = 5) =>
|
const lessPrecise = (num: number, precision = 5) =>
|
||||||
parseFloat(num.toPrecision(precision));
|
parseFloat(num.toPrecision(precision));
|
||||||
|
|
||||||
@@ -157,6 +151,70 @@ export class Debug {
|
|||||||
return ret;
|
return ret;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
private static CHANGED_CACHE: Record<string, Record<string, unknown>> = {};
|
||||||
|
|
||||||
|
public static logChanged(name: string, obj: Record<string, unknown>) {
|
||||||
|
const prev = Debug.CHANGED_CACHE[name];
|
||||||
|
|
||||||
|
Debug.CHANGED_CACHE[name] = obj;
|
||||||
|
|
||||||
|
if (!prev) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const allKeys = new Set([...Object.keys(prev), ...Object.keys(obj)]);
|
||||||
|
const changed: Record<string, { prev: unknown; next: unknown }> = {};
|
||||||
|
|
||||||
|
for (const key of allKeys) {
|
||||||
|
const prevVal = prev[key];
|
||||||
|
const nextVal = obj[key];
|
||||||
|
if (!deepEqual(prevVal, nextVal)) {
|
||||||
|
changed[key] = { prev: prevVal, next: nextVal };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Object.keys(changed).length > 0) {
|
||||||
|
console.info(`[${name}] changed:`, changed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function deepEqual(a: unknown, b: unknown): boolean {
|
||||||
|
if (Object.is(a, b)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
a === null ||
|
||||||
|
b === null ||
|
||||||
|
typeof a !== "object" ||
|
||||||
|
typeof b !== "object"
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(a) !== Array.isArray(b)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const keysA = Object.keys(a as Record<string, unknown>);
|
||||||
|
const keysB = Object.keys(b as Record<string, unknown>);
|
||||||
|
|
||||||
|
if (keysA.length !== keysB.length) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const key of keysA) {
|
||||||
|
if (
|
||||||
|
!deepEqual(
|
||||||
|
(a as Record<string, unknown>)[key],
|
||||||
|
(b as Record<string, unknown>)[key],
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
//@ts-ignore
|
|
||||||
window.debug = Debug;
|
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
import { AppEventBus } from "./appEventBus";
|
||||||
|
|
||||||
|
type TestEvents = {
|
||||||
|
initialize: [api: number];
|
||||||
|
pointerUp: [pointerId: string];
|
||||||
|
viewState: [zoom: number];
|
||||||
|
};
|
||||||
|
|
||||||
|
const behavior = {
|
||||||
|
initialize: { cardinality: "once", replay: "last" },
|
||||||
|
pointerUp: { cardinality: "many", replay: "none" },
|
||||||
|
viewState: { cardinality: "many", replay: "last" },
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
const flushMicrotasks = async () => Promise.resolve();
|
||||||
|
|
||||||
|
describe("AppEventBus", () => {
|
||||||
|
it("replays once events to late callback and Promise subscribers", async () => {
|
||||||
|
const bus = new AppEventBus<TestEvents, typeof behavior>(behavior);
|
||||||
|
bus.emit("initialize", 42);
|
||||||
|
|
||||||
|
const calls: number[] = [];
|
||||||
|
bus.on("initialize", (value) => {
|
||||||
|
calls.push(value);
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(calls).toEqual([]);
|
||||||
|
await flushMicrotasks();
|
||||||
|
expect(calls).toEqual([42]);
|
||||||
|
|
||||||
|
await expect(bus.on("initialize")).resolves.toBe(42);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not replay stream events to late subscribers", async () => {
|
||||||
|
const bus = new AppEventBus<TestEvents, typeof behavior>(behavior);
|
||||||
|
bus.emit("pointerUp", "first");
|
||||||
|
|
||||||
|
const calls: string[] = [];
|
||||||
|
bus.on("pointerUp", (pointerId) => {
|
||||||
|
calls.push(pointerId);
|
||||||
|
});
|
||||||
|
|
||||||
|
await flushMicrotasks();
|
||||||
|
expect(calls).toEqual([]);
|
||||||
|
|
||||||
|
bus.emit("pointerUp", "second");
|
||||||
|
expect(calls).toEqual(["second"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("replays replay-last stream events and stays subscribed", async () => {
|
||||||
|
const bus = new AppEventBus<TestEvents, typeof behavior>(behavior);
|
||||||
|
bus.emit("viewState", 1);
|
||||||
|
|
||||||
|
const calls: number[] = [];
|
||||||
|
bus.on("viewState", (zoom) => {
|
||||||
|
calls.push(zoom);
|
||||||
|
});
|
||||||
|
|
||||||
|
await flushMicrotasks();
|
||||||
|
expect(calls).toEqual([1]);
|
||||||
|
|
||||||
|
bus.emit("viewState", 2);
|
||||||
|
expect(calls).toEqual([1, 2]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("throws when emitting a once event twice", () => {
|
||||||
|
const bus = new AppEventBus<TestEvents, typeof behavior>(behavior);
|
||||||
|
bus.emit("initialize", 1);
|
||||||
|
|
||||||
|
expect(() => {
|
||||||
|
bus.emit("initialize", 2);
|
||||||
|
}).toThrow('Event "initialize" can only be emitted once');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
import type { UnsubscribeCallback } from "@excalidraw/excalidraw/types";
|
||||||
|
|
||||||
|
import { Emitter } from "./emitter";
|
||||||
|
import { isProdEnv } from "./utils";
|
||||||
|
|
||||||
|
export type AppEventPayloadMap = Record<string, unknown[]>;
|
||||||
|
|
||||||
|
export type AppEventBehavior = {
|
||||||
|
cardinality: "once" | "many";
|
||||||
|
replay: "none" | "last";
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AppEventBehaviorMap<Events extends AppEventPayloadMap> = {
|
||||||
|
[K in keyof Events]: AppEventBehavior;
|
||||||
|
};
|
||||||
|
|
||||||
|
type AwaitableAppEventKeys<
|
||||||
|
Events extends AppEventPayloadMap,
|
||||||
|
Behavior extends AppEventBehaviorMap<Events>,
|
||||||
|
> = {
|
||||||
|
[K in keyof Events]: Behavior[K]["cardinality"] extends "once"
|
||||||
|
? Behavior[K]["replay"] extends "last"
|
||||||
|
? K
|
||||||
|
: never
|
||||||
|
: never;
|
||||||
|
}[keyof Events];
|
||||||
|
|
||||||
|
type AppEventPromiseValue<Args extends any[]> = Args extends [infer Only]
|
||||||
|
? Only
|
||||||
|
: Args;
|
||||||
|
|
||||||
|
export class AppEventBus<
|
||||||
|
Events extends AppEventPayloadMap,
|
||||||
|
Behavior extends AppEventBehaviorMap<Events>,
|
||||||
|
> {
|
||||||
|
private readonly emitters = new Map<keyof Events, Emitter<any>>();
|
||||||
|
private readonly lastPayload = new Map<keyof Events, any[]>();
|
||||||
|
private readonly emittedOnce = new Set<keyof Events>();
|
||||||
|
|
||||||
|
constructor(private readonly behavior: Behavior) {}
|
||||||
|
|
||||||
|
private getEmitter<K extends keyof Events>(name: K): Emitter<Events[K]> {
|
||||||
|
let emitter = this.emitters.get(name);
|
||||||
|
if (!emitter) {
|
||||||
|
emitter = new Emitter<any>();
|
||||||
|
this.emitters.set(name, emitter);
|
||||||
|
}
|
||||||
|
return emitter as Emitter<Events[K]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
private toPromiseValue<Args extends any[]>(
|
||||||
|
args: Args,
|
||||||
|
): AppEventPromiseValue<Args> {
|
||||||
|
return (args.length === 1 ? args[0] : args) as AppEventPromiseValue<Args>;
|
||||||
|
}
|
||||||
|
|
||||||
|
public on<K extends keyof Events>(
|
||||||
|
name: K,
|
||||||
|
callback: (...args: Events[K]) => void,
|
||||||
|
): UnsubscribeCallback;
|
||||||
|
public on<K extends AwaitableAppEventKeys<Events, Behavior>>(
|
||||||
|
name: K,
|
||||||
|
): Promise<AppEventPromiseValue<Events[K]>>;
|
||||||
|
public on<K extends keyof Events>(
|
||||||
|
name: K,
|
||||||
|
callback?: (...args: Events[K]) => void,
|
||||||
|
): UnsubscribeCallback | Promise<AppEventPromiseValue<Events[K]>> {
|
||||||
|
const eventBehavior = this.behavior[name];
|
||||||
|
const cachedPayload = this.lastPayload.get(name) as Events[K] | undefined;
|
||||||
|
|
||||||
|
if (callback) {
|
||||||
|
if (eventBehavior.replay === "last" && cachedPayload) {
|
||||||
|
queueMicrotask(() => callback(...cachedPayload));
|
||||||
|
|
||||||
|
if (eventBehavior.cardinality === "once") {
|
||||||
|
return () => {};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.getEmitter(name).on(callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
eventBehavior.cardinality !== "once" ||
|
||||||
|
eventBehavior.replay !== "last"
|
||||||
|
) {
|
||||||
|
throw new Error(`Event "${String(name)}" requires a callback`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cachedPayload) {
|
||||||
|
return Promise.resolve(this.toPromiseValue(cachedPayload));
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Promise<AppEventPromiseValue<Events[K]>>((resolve) => {
|
||||||
|
this.getEmitter(name).once((...args: Events[K]) => {
|
||||||
|
resolve(this.toPromiseValue(args));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public emit<K extends keyof Events>(name: K, ...args: Events[K]) {
|
||||||
|
const eventBehavior = this.behavior[name];
|
||||||
|
|
||||||
|
if (!isProdEnv()) {
|
||||||
|
if (eventBehavior.cardinality === "once") {
|
||||||
|
if (this.emittedOnce.has(name)) {
|
||||||
|
throw new Error(`Event "${String(name)}" can only be emitted once`);
|
||||||
|
}
|
||||||
|
this.emittedOnce.add(name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (eventBehavior.replay === "last") {
|
||||||
|
this.lastPayload.set(name, args);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
this.getEmitter(name).trigger(...args);
|
||||||
|
} finally {
|
||||||
|
if (eventBehavior.cardinality === "once") {
|
||||||
|
this.getEmitter(name).clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public clear() {
|
||||||
|
this.lastPayload.clear();
|
||||||
|
this.emittedOnce.clear();
|
||||||
|
|
||||||
|
for (const emitter of this.emitters.values()) {
|
||||||
|
emitter.clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
this.emitters.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -240,22 +240,21 @@ export const DEFAULT_ELEMENT_BACKGROUND_COLOR_PALETTE = {
|
|||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
// !!!MUST BE WITHOUT GRAY, TRANSPARENT AND BLACK!!!
|
// !!!MUST BE WITHOUT GRAY, TRANSPARENT AND BLACK!!!
|
||||||
export const getAllColorsSpecificShade = (index: 0 | 1 | 2 | 3 | 4) =>
|
export const getAllColorsSpecificShade = (index: 0 | 1 | 2 | 3 | 4) => [
|
||||||
[
|
// 2nd row
|
||||||
// 2nd row
|
COLOR_PALETTE.cyan[index],
|
||||||
COLOR_PALETTE.cyan[index],
|
COLOR_PALETTE.blue[index],
|
||||||
COLOR_PALETTE.blue[index],
|
COLOR_PALETTE.violet[index],
|
||||||
COLOR_PALETTE.violet[index],
|
COLOR_PALETTE.grape[index],
|
||||||
COLOR_PALETTE.grape[index],
|
COLOR_PALETTE.pink[index],
|
||||||
COLOR_PALETTE.pink[index],
|
|
||||||
|
|
||||||
// 3rd row
|
// 3rd row
|
||||||
COLOR_PALETTE.green[index],
|
COLOR_PALETTE.green[index],
|
||||||
COLOR_PALETTE.teal[index],
|
COLOR_PALETTE.teal[index],
|
||||||
COLOR_PALETTE.yellow[index],
|
COLOR_PALETTE.yellow[index],
|
||||||
COLOR_PALETTE.orange[index],
|
COLOR_PALETTE.orange[index],
|
||||||
COLOR_PALETTE.red[index],
|
COLOR_PALETTE.red[index],
|
||||||
] as const;
|
];
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
// other helpers
|
// other helpers
|
||||||
|
|||||||
@@ -11,4 +11,7 @@ export * from "./random";
|
|||||||
export * from "./url";
|
export * from "./url";
|
||||||
export * from "./utils";
|
export * from "./utils";
|
||||||
export * from "./emitter";
|
export * from "./emitter";
|
||||||
|
export * from "./appEventBus";
|
||||||
export * from "./editorInterface";
|
export * from "./editorInterface";
|
||||||
|
export * from "./versionedSnapshotStore";
|
||||||
|
export { Debug } from "../debug";
|
||||||
|
|||||||
@@ -3,6 +3,12 @@ import {
|
|||||||
mapFind,
|
mapFind,
|
||||||
reduceToCommonValue,
|
reduceToCommonValue,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
|
import { vi } from "vitest";
|
||||||
|
|
||||||
|
// Import directly to avoid the @excalidraw/common throttleRAF mock from setupTests.ts.
|
||||||
|
import { throttleRAF } from "./utils";
|
||||||
|
|
||||||
|
type RafCallback = FrameRequestCallback;
|
||||||
|
|
||||||
describe("@excalidraw/common/utils", () => {
|
describe("@excalidraw/common/utils", () => {
|
||||||
describe("isTransparent()", () => {
|
describe("isTransparent()", () => {
|
||||||
@@ -79,4 +85,87 @@ describe("@excalidraw/common/utils", () => {
|
|||||||
expect(mapFind([1, 2], () => null)).toBe(undefined);
|
expect(mapFind([1, 2], () => null)).toBe(undefined);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("throttleRAF()", () => {
|
||||||
|
let frameCallbacks: Map<number, RafCallback>;
|
||||||
|
let nextFrameId: number;
|
||||||
|
|
||||||
|
const runScheduledFrame = (timestamp = 16) => {
|
||||||
|
const callbacks = [...frameCallbacks.values()];
|
||||||
|
frameCallbacks.clear();
|
||||||
|
callbacks.forEach((callback) => callback(timestamp));
|
||||||
|
};
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
frameCallbacks = new Map();
|
||||||
|
nextFrameId = 0;
|
||||||
|
|
||||||
|
vi.spyOn(window, "requestAnimationFrame").mockImplementation(
|
||||||
|
(callback) => {
|
||||||
|
const frameId = ++nextFrameId;
|
||||||
|
frameCallbacks.set(frameId, callback);
|
||||||
|
return frameId;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
vi.spyOn(window, "cancelAnimationFrame").mockImplementation((frameId) => {
|
||||||
|
frameCallbacks.delete(frameId);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
vi.restoreAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should invoke the callback with the last args from the same frame", () => {
|
||||||
|
const fn = vi.fn();
|
||||||
|
const throttled = throttleRAF(fn);
|
||||||
|
|
||||||
|
throttled("first", 1);
|
||||||
|
throttled("second", 2);
|
||||||
|
throttled("last", 3);
|
||||||
|
|
||||||
|
expect(fn).not.toHaveBeenCalled();
|
||||||
|
expect(window.requestAnimationFrame).toHaveBeenCalledTimes(1);
|
||||||
|
|
||||||
|
runScheduledFrame();
|
||||||
|
|
||||||
|
expect(fn).toHaveBeenCalledTimes(1);
|
||||||
|
expect(fn).toHaveBeenCalledWith("last", 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should flush the pending callback immediately", () => {
|
||||||
|
const fn = vi.fn();
|
||||||
|
const throttled = throttleRAF(fn);
|
||||||
|
|
||||||
|
throttled("first");
|
||||||
|
throttled("last");
|
||||||
|
|
||||||
|
throttled.flush();
|
||||||
|
|
||||||
|
expect(window.cancelAnimationFrame).toHaveBeenCalledTimes(1);
|
||||||
|
expect(fn).toHaveBeenCalledTimes(1);
|
||||||
|
expect(fn).toHaveBeenCalledWith("last");
|
||||||
|
|
||||||
|
runScheduledFrame();
|
||||||
|
|
||||||
|
expect(fn).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should cancel the pending callback", () => {
|
||||||
|
const fn = vi.fn();
|
||||||
|
const throttled = throttleRAF(fn);
|
||||||
|
|
||||||
|
throttled("first");
|
||||||
|
throttled("last");
|
||||||
|
|
||||||
|
throttled.cancel();
|
||||||
|
|
||||||
|
expect(window.cancelAnimationFrame).toHaveBeenCalledTimes(1);
|
||||||
|
|
||||||
|
runScheduledFrame();
|
||||||
|
|
||||||
|
expect(fn).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
import { average } from "@excalidraw/math";
|
import { average } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import type { GlobalCoord } from "@excalidraw/math";
|
||||||
|
|
||||||
import type { FontFamilyValues, FontString } from "@excalidraw/element/types";
|
import type { FontFamilyValues, FontString } from "@excalidraw/element/types";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
@@ -86,7 +88,8 @@ export const isWritableElement = (
|
|||||||
(target.type === "text" ||
|
(target.type === "text" ||
|
||||||
target.type === "number" ||
|
target.type === "number" ||
|
||||||
target.type === "password" ||
|
target.type === "password" ||
|
||||||
target.type === "search"));
|
target.type === "search")) ||
|
||||||
|
(target instanceof HTMLElement && target.closest(".cm-editor") !== null);
|
||||||
|
|
||||||
export const getFontFamilyString = ({
|
export const getFontFamilyString = ({
|
||||||
fontFamily,
|
fontFamily,
|
||||||
@@ -148,38 +151,27 @@ export const debounce = <T extends any[]>(
|
|||||||
return ret;
|
return ret;
|
||||||
};
|
};
|
||||||
|
|
||||||
// throttle callback to execute once per animation frame
|
// throttle callback to execute once per animation frame using the latest args
|
||||||
export const throttleRAF = <T extends any[]>(
|
export const throttleRAF = <T extends any[]>(fn: (...args: T) => void) => {
|
||||||
fn: (...args: T) => void,
|
|
||||||
opts?: { trailing?: boolean },
|
|
||||||
) => {
|
|
||||||
let timerId: number | null = null;
|
let timerId: number | null = null;
|
||||||
let lastArgs: T | null = null;
|
let lastArgs: T | null = null;
|
||||||
let lastArgsTrailing: T | null = null;
|
|
||||||
|
|
||||||
const scheduleFunc = (args: T) => {
|
const scheduleFunc = () => {
|
||||||
timerId = window.requestAnimationFrame(() => {
|
timerId = window.requestAnimationFrame(() => {
|
||||||
timerId = null;
|
timerId = null;
|
||||||
fn(...args);
|
const args = lastArgs;
|
||||||
lastArgs = null;
|
lastArgs = null;
|
||||||
if (lastArgsTrailing) {
|
|
||||||
lastArgs = lastArgsTrailing;
|
if (args) {
|
||||||
lastArgsTrailing = null;
|
fn(...args);
|
||||||
scheduleFunc(lastArgs);
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
const ret = (...args: T) => {
|
const ret = (...args: T) => {
|
||||||
if (isTestEnv()) {
|
|
||||||
fn(...args);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
lastArgs = args;
|
lastArgs = args;
|
||||||
if (timerId === null) {
|
if (timerId === null) {
|
||||||
scheduleFunc(lastArgs);
|
scheduleFunc();
|
||||||
} else if (opts?.trailing) {
|
|
||||||
lastArgsTrailing = args;
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
ret.flush = () => {
|
ret.flush = () => {
|
||||||
@@ -188,12 +180,12 @@ export const throttleRAF = <T extends any[]>(
|
|||||||
timerId = null;
|
timerId = null;
|
||||||
}
|
}
|
||||||
if (lastArgs) {
|
if (lastArgs) {
|
||||||
fn(...(lastArgsTrailing || lastArgs));
|
fn(...lastArgs);
|
||||||
lastArgs = lastArgsTrailing = null;
|
lastArgs = null;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
ret.cancel = () => {
|
ret.cancel = () => {
|
||||||
lastArgs = lastArgsTrailing = null;
|
lastArgs = null;
|
||||||
if (timerId !== null) {
|
if (timerId !== null) {
|
||||||
cancelAnimationFrame(timerId);
|
cancelAnimationFrame(timerId);
|
||||||
timerId = null;
|
timerId = null;
|
||||||
@@ -441,7 +433,7 @@ export const viewportCoordsToSceneCoords = (
|
|||||||
const x = (clientX - offsetLeft) / zoom.value - scrollX;
|
const x = (clientX - offsetLeft) / zoom.value - scrollX;
|
||||||
const y = (clientY - offsetTop) / zoom.value - scrollY;
|
const y = (clientY - offsetTop) / zoom.value - scrollY;
|
||||||
|
|
||||||
return { x, y };
|
return { x, y } as GlobalCoord;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const sceneCoordsToViewportCoords = (
|
export const sceneCoordsToViewportCoords = (
|
||||||
@@ -1330,3 +1322,10 @@ export const setFeatureFlag = <F extends keyof FEATURE_FLAGS>(
|
|||||||
console.error("unable to set feature flag", e);
|
console.error("unable to set feature flag", e);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const oneOf = <N extends string | number | symbol | null, H extends N>(
|
||||||
|
needle: N,
|
||||||
|
haystack: readonly H[],
|
||||||
|
): needle is H => {
|
||||||
|
return haystack.includes(needle as any);
|
||||||
|
};
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
export type VersionedSnapshot<T> = Readonly<{
|
||||||
|
version: number;
|
||||||
|
value: T;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export class VersionedSnapshotStore<T> {
|
||||||
|
private version = 0;
|
||||||
|
private value: T;
|
||||||
|
private readonly waiters = new Set<
|
||||||
|
(snapshot: VersionedSnapshot<T>) => void
|
||||||
|
>();
|
||||||
|
private readonly subscribers = new Set<
|
||||||
|
(snapshot: VersionedSnapshot<T>) => void
|
||||||
|
>();
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
initialValue: T,
|
||||||
|
private readonly isEqual: (prev: T, next: T) => boolean = Object.is,
|
||||||
|
) {
|
||||||
|
this.value = initialValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
public getSnapshot(): VersionedSnapshot<T> {
|
||||||
|
return { version: this.version, value: this.value };
|
||||||
|
}
|
||||||
|
|
||||||
|
public set(nextValue: T): boolean {
|
||||||
|
if (this.isEqual(this.value, nextValue)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.value = nextValue;
|
||||||
|
this.version += 1;
|
||||||
|
|
||||||
|
const snapshot = this.getSnapshot();
|
||||||
|
|
||||||
|
for (const subscriber of this.subscribers) {
|
||||||
|
subscriber(snapshot);
|
||||||
|
}
|
||||||
|
for (const waiter of this.waiters) {
|
||||||
|
waiter(snapshot);
|
||||||
|
}
|
||||||
|
this.waiters.clear();
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public update(updater: (prev: T) => T): boolean {
|
||||||
|
return this.set(updater(this.value));
|
||||||
|
}
|
||||||
|
|
||||||
|
public subscribe(
|
||||||
|
subscriber: (snapshot: VersionedSnapshot<T>) => void,
|
||||||
|
): () => void {
|
||||||
|
this.subscribers.add(subscriber);
|
||||||
|
return () => {
|
||||||
|
this.subscribers.delete(subscriber);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
public pull(sinceVersion = -1): Promise<VersionedSnapshot<T>> {
|
||||||
|
if (this.version !== sinceVersion) {
|
||||||
|
return Promise.resolve(this.getSnapshot());
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
this.waiters.add(resolve);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -438,6 +438,8 @@ export class Scene {
|
|||||||
options: {
|
options: {
|
||||||
informMutation: boolean;
|
informMutation: boolean;
|
||||||
isDragging: boolean;
|
isDragging: boolean;
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
} = {
|
} = {
|
||||||
informMutation: true,
|
informMutation: true,
|
||||||
isDragging: false,
|
isDragging: false,
|
||||||
|
|||||||
@@ -27,9 +27,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing s
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#66a80f",
|
"strokeColor": "#66a80f",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -67,9 +64,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing s
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#9c36b5",
|
"strokeColor": "#9c36b5",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -122,9 +116,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing s
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -186,9 +177,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing s
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -235,9 +223,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing s
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -281,9 +266,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing t
|
|||||||
"originalText": "HEYYYYY",
|
"originalText": "HEYYYYY",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#c2255c",
|
"strokeColor": "#c2255c",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -330,9 +312,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing t
|
|||||||
"originalText": "Whats up ?",
|
"originalText": "Whats up ?",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -393,9 +372,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing t
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -443,9 +419,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to existing t
|
|||||||
"originalText": "HELLO WORLD!!",
|
"originalText": "HELLO WORLD!!",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -506,9 +479,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to shapes whe
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -556,9 +526,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to shapes whe
|
|||||||
"originalText": "HELLO WORLD!!",
|
"originalText": "HELLO WORLD!!",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -599,9 +566,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to shapes whe
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -639,9 +603,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to shapes whe
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -699,9 +660,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to text when
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -749,9 +707,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to text when
|
|||||||
"originalText": "HELLO WORLD!!",
|
"originalText": "HELLO WORLD!!",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -798,9 +753,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to text when
|
|||||||
"originalText": "HEYYYYY",
|
"originalText": "HEYYYYY",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -847,9 +799,6 @@ exports[`Test Transform > Test arrow bindings > should bind arrows to text when
|
|||||||
"originalText": "WHATS UP ?",
|
"originalText": "WHATS UP ?",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -885,9 +834,6 @@ exports[`Test Transform > should not allow duplicate ids 1`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -933,9 +879,6 @@ exports[`Test Transform > should transform linear elements 1`] = `
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -983,9 +926,6 @@ exports[`Test Transform > should transform linear elements 2`] = `
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": "dot",
|
"startArrowhead": "dot",
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -1033,9 +973,6 @@ exports[`Test Transform > should transform linear elements 3`] = `
|
|||||||
"polygon": false,
|
"polygon": false,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -1083,9 +1020,6 @@ exports[`Test Transform > should transform linear elements 4`] = `
|
|||||||
"polygon": false,
|
"polygon": false,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -1120,9 +1054,6 @@ exports[`Test Transform > should transform regular shapes 1`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1155,9 +1086,6 @@ exports[`Test Transform > should transform regular shapes 2`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1190,9 +1118,6 @@ exports[`Test Transform > should transform regular shapes 3`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1225,9 +1150,6 @@ exports[`Test Transform > should transform regular shapes 4`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1260,9 +1182,6 @@ exports[`Test Transform > should transform regular shapes 5`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "dotted",
|
"strokeStyle": "dotted",
|
||||||
@@ -1295,9 +1214,6 @@ exports[`Test Transform > should transform regular shapes 6`] = `
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1971c2",
|
"strokeColor": "#1971c2",
|
||||||
"strokeStyle": "dashed",
|
"strokeStyle": "dashed",
|
||||||
@@ -1336,9 +1252,6 @@ exports[`Test Transform > should transform text element 1`] = `
|
|||||||
"originalText": "HELLO WORLD!",
|
"originalText": "HELLO WORLD!",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1380,9 +1293,6 @@ exports[`Test Transform > should transform text element 2`] = `
|
|||||||
"originalText": "STYLED HELLO WORLD!",
|
"originalText": "STYLED HELLO WORLD!",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#5f3dc4",
|
"strokeColor": "#5f3dc4",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1429,9 +1339,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1471,9 +1378,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1517,9 +1421,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1567,9 +1468,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1629,9 +1527,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"roundness": {
|
"roundness": {
|
||||||
"type": 2,
|
"type": 2,
|
||||||
},
|
},
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -1696,9 +1591,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"roundness": {
|
"roundness": {
|
||||||
"type": 2,
|
"type": 2,
|
||||||
},
|
},
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": {
|
"startBinding": {
|
||||||
@@ -1748,9 +1640,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "B",
|
"originalText": "B",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1794,9 +1683,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "A",
|
"originalText": "A",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1840,9 +1726,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "Alice",
|
"originalText": "Alice",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1886,9 +1769,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "Bob",
|
"originalText": "Bob",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1930,9 +1810,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "How are you?",
|
"originalText": "How are you?",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -1974,9 +1851,6 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
|||||||
"originalText": "Friendship",
|
"originalText": "Friendship",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2030,9 +1904,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -2085,9 +1956,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -2140,9 +2008,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -2195,9 +2060,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
],
|
],
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"startArrowhead": null,
|
"startArrowhead": null,
|
||||||
"startBinding": null,
|
"startBinding": null,
|
||||||
@@ -2238,9 +2100,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
"originalText": "LABELED ARROW",
|
"originalText": "LABELED ARROW",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2282,9 +2141,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
"originalText": "STYLED LABELED ARROW",
|
"originalText": "STYLED LABELED ARROW",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#099268",
|
"strokeColor": "#099268",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2326,9 +2182,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
"originalText": "ANOTHER STYLED LABELLED ARROW",
|
"originalText": "ANOTHER STYLED LABELLED ARROW",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1098ad",
|
"strokeColor": "#1098ad",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2371,9 +2224,6 @@ exports[`Test Transform > should transform to labelled arrows when label provide
|
|||||||
"originalText": "ANOTHER STYLED LABELLED ARROW",
|
"originalText": "ANOTHER STYLED LABELLED ARROW",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#099268",
|
"strokeColor": "#099268",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2415,9 +2265,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2455,9 +2302,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2495,9 +2339,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2535,9 +2376,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2575,9 +2413,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#c2255c",
|
"strokeColor": "#c2255c",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2615,9 +2450,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"opacity": 100,
|
"opacity": 100,
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#f08c00",
|
"strokeColor": "#f08c00",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2656,9 +2488,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"originalText": "RECTANGLE TEXT CONTAINER",
|
"originalText": "RECTANGLE TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2700,9 +2529,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"originalText": "ELLIPSE TEXT CONTAINER",
|
"originalText": "ELLIPSE TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2746,9 +2572,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
TEXT CONTAINER",
|
TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#1e1e1e",
|
"strokeColor": "#1e1e1e",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2792,9 +2615,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"originalText": "STYLED DIAMOND TEXT CONTAINER",
|
"originalText": "STYLED DIAMOND TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#099268",
|
"strokeColor": "#099268",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2837,9 +2657,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"originalText": "TOP LEFT ALIGNED RECTANGLE TEXT CONTAINER",
|
"originalText": "TOP LEFT ALIGNED RECTANGLE TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#c2255c",
|
"strokeColor": "#c2255c",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
@@ -2883,9 +2700,6 @@ exports[`Test Transform > should transform to text containers when label provide
|
|||||||
"originalText": "STYLED ELLIPSE TEXT CONTAINER",
|
"originalText": "STYLED ELLIPSE TEXT CONTAINER",
|
||||||
"roughness": 1,
|
"roughness": 1,
|
||||||
"roundness": null,
|
"roundness": null,
|
||||||
"schemaState": {
|
|
||||||
"tracks": {},
|
|
||||||
},
|
|
||||||
"seed": Any<Number>,
|
"seed": Any<Number>,
|
||||||
"strokeColor": "#c2255c",
|
"strokeColor": "#c2255c",
|
||||||
"strokeStyle": "solid",
|
"strokeStyle": "solid",
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import {
|
import {
|
||||||
KEYS,
|
|
||||||
arrayToMap,
|
arrayToMap,
|
||||||
getFeatureFlag,
|
getFeatureFlag,
|
||||||
invariant,
|
invariant,
|
||||||
@@ -137,12 +136,6 @@ export const maxBindingDistance_simple = (zoom?: AppState["zoom"]): number => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const shouldEnableBindingForPointerEvent = (
|
|
||||||
event: React.PointerEvent<HTMLElement>,
|
|
||||||
) => {
|
|
||||||
return !event[KEYS.CTRL_OR_CMD];
|
|
||||||
};
|
|
||||||
|
|
||||||
export const isBindingEnabled = (appState: {
|
export const isBindingEnabled = (appState: {
|
||||||
isBindingEnabled: AppState["isBindingEnabled"];
|
isBindingEnabled: AppState["isBindingEnabled"];
|
||||||
}): boolean => {
|
}): boolean => {
|
||||||
@@ -177,8 +170,20 @@ export const bindOrUnbindBindingElement = (
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
bindOrUnbindBindingElementEdge(arrow, start, "start", scene);
|
bindOrUnbindBindingElementEdge(
|
||||||
bindOrUnbindBindingElementEdge(arrow, end, "end", scene);
|
arrow,
|
||||||
|
start,
|
||||||
|
"start",
|
||||||
|
scene,
|
||||||
|
appState.isBindingEnabled,
|
||||||
|
);
|
||||||
|
bindOrUnbindBindingElementEdge(
|
||||||
|
arrow,
|
||||||
|
end,
|
||||||
|
"end",
|
||||||
|
scene,
|
||||||
|
appState.isBindingEnabled,
|
||||||
|
);
|
||||||
if (start.focusPoint || end.focusPoint) {
|
if (start.focusPoint || end.focusPoint) {
|
||||||
// If the strategy dictates a focus point override, then
|
// If the strategy dictates a focus point override, then
|
||||||
// update the arrow points to point to the focus point.
|
// update the arrow points to point to the focus point.
|
||||||
@@ -221,12 +226,21 @@ const bindOrUnbindBindingElementEdge = (
|
|||||||
{ mode, element, focusPoint }: BindingStrategy,
|
{ mode, element, focusPoint }: BindingStrategy,
|
||||||
startOrEnd: "start" | "end",
|
startOrEnd: "start" | "end",
|
||||||
scene: Scene,
|
scene: Scene,
|
||||||
|
shouldSnapToOutline = true,
|
||||||
): void => {
|
): void => {
|
||||||
if (mode === null) {
|
if (mode === null) {
|
||||||
// null means break the binding
|
// null means break the binding
|
||||||
unbindBindingElement(arrow, startOrEnd, scene);
|
unbindBindingElement(arrow, startOrEnd, scene);
|
||||||
} else if (mode !== undefined) {
|
} else if (mode !== undefined) {
|
||||||
bindBindingElement(arrow, element, mode, startOrEnd, scene, focusPoint);
|
bindBindingElement(
|
||||||
|
arrow,
|
||||||
|
element,
|
||||||
|
mode,
|
||||||
|
startOrEnd,
|
||||||
|
scene,
|
||||||
|
focusPoint,
|
||||||
|
shouldSnapToOutline,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -798,6 +812,7 @@ const getBindingStrategyForDraggingBindingElementEndpoints_simple = (
|
|||||||
startDragged ? "start" : "end",
|
startDragged ? "start" : "end",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
appState.zoom,
|
appState.zoom,
|
||||||
|
appState.isMidpointSnappingEnabled,
|
||||||
) || globalPoint,
|
) || globalPoint,
|
||||||
}
|
}
|
||||||
: { mode: null };
|
: { mode: null };
|
||||||
@@ -842,6 +857,7 @@ const getBindingStrategyForDraggingBindingElementEndpoints_simple = (
|
|||||||
startDragged ? "end" : "start",
|
startDragged ? "end" : "start",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
appState.zoom,
|
appState.zoom,
|
||||||
|
appState.isMidpointSnappingEnabled,
|
||||||
) || otherEndpoint,
|
) || otherEndpoint,
|
||||||
}
|
}
|
||||||
: { mode: undefined }
|
: { mode: undefined }
|
||||||
@@ -1005,6 +1021,7 @@ export const bindBindingElement = (
|
|||||||
startOrEnd: "start" | "end",
|
startOrEnd: "start" | "end",
|
||||||
scene: Scene,
|
scene: Scene,
|
||||||
focusPoint?: GlobalPoint,
|
focusPoint?: GlobalPoint,
|
||||||
|
shouldSnapToOutline = true,
|
||||||
): void => {
|
): void => {
|
||||||
const elementsMap = scene.getNonDeletedElementsMap();
|
const elementsMap = scene.getNonDeletedElementsMap();
|
||||||
|
|
||||||
@@ -1019,6 +1036,7 @@ export const bindBindingElement = (
|
|||||||
hoveredElement,
|
hoveredElement,
|
||||||
startOrEnd,
|
startOrEnd,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
|
shouldSnapToOutline,
|
||||||
),
|
),
|
||||||
};
|
};
|
||||||
} else {
|
} else {
|
||||||
@@ -1352,6 +1370,7 @@ export const bindPointToSnapToElementOutline = (
|
|||||||
startOrEnd: "start" | "end",
|
startOrEnd: "start" | "end",
|
||||||
elementsMap: ElementsMap,
|
elementsMap: ElementsMap,
|
||||||
customIntersector?: LineSegment<GlobalPoint>,
|
customIntersector?: LineSegment<GlobalPoint>,
|
||||||
|
isMidpointSnappingEnabled = true,
|
||||||
): GlobalPoint => {
|
): GlobalPoint => {
|
||||||
const elbowed = isElbowArrow(arrowElement);
|
const elbowed = isElbowArrow(arrowElement);
|
||||||
const point = LinearElementEditor.getPointAtIndexGlobalCoordinates(
|
const point = LinearElementEditor.getPointAtIndexGlobalCoordinates(
|
||||||
@@ -1391,13 +1410,9 @@ export const bindPointToSnapToElementOutline = (
|
|||||||
const isHorizontal = headingIsHorizontal(
|
const isHorizontal = headingIsHorizontal(
|
||||||
headingForPointFromElement(bindableElement, aabb, point),
|
headingForPointFromElement(bindableElement, aabb, point),
|
||||||
);
|
);
|
||||||
const snapPoint = snapToMid(
|
const snapPoint = isMidpointSnappingEnabled
|
||||||
bindableElement,
|
? snapToMid(bindableElement, elementsMap, edgePoint, 0.05, arrowElement)
|
||||||
elementsMap,
|
: undefined;
|
||||||
edgePoint,
|
|
||||||
0.05,
|
|
||||||
arrowElement,
|
|
||||||
);
|
|
||||||
const resolved = snapPoint || point;
|
const resolved = snapPoint || point;
|
||||||
const otherPoint = pointFrom<GlobalPoint>(
|
const otherPoint = pointFrom<GlobalPoint>(
|
||||||
isHorizontal ? bindableCenter[0] : resolved[0],
|
isHorizontal ? bindableCenter[0] : resolved[0],
|
||||||
@@ -1776,10 +1791,13 @@ export const updateBoundPoint = (
|
|||||||
);
|
);
|
||||||
const otherArrowPoint = LinearElementEditor.getPointAtIndexGlobalCoordinates(
|
const otherArrowPoint = LinearElementEditor.getPointAtIndexGlobalCoordinates(
|
||||||
arrow,
|
arrow,
|
||||||
startOrEnd === "startBinding" ? -1 : 0,
|
startOrEnd === "startBinding" ? 1 : -2,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
);
|
);
|
||||||
const otherFocusPointOrArrowPoint = otherFocusPoint || otherArrowPoint;
|
const otherFocusPointOrArrowPoint =
|
||||||
|
arrow.points.length === 2
|
||||||
|
? otherFocusPoint || otherArrowPoint
|
||||||
|
: otherArrowPoint;
|
||||||
const intersector =
|
const intersector =
|
||||||
otherFocusPointOrArrowPoint &&
|
otherFocusPointOrArrowPoint &&
|
||||||
lineSegment(focusPoint, otherFocusPointOrArrowPoint);
|
lineSegment(focusPoint, otherFocusPointOrArrowPoint);
|
||||||
@@ -1889,6 +1907,8 @@ export const calculateFixedPointForElbowArrowBinding = (
|
|||||||
hoveredElement: ExcalidrawBindableElement,
|
hoveredElement: ExcalidrawBindableElement,
|
||||||
startOrEnd: "start" | "end",
|
startOrEnd: "start" | "end",
|
||||||
elementsMap: ElementsMap,
|
elementsMap: ElementsMap,
|
||||||
|
shouldSnapToOutline = true,
|
||||||
|
isMidpointSnappingEnabled = true,
|
||||||
): { fixedPoint: FixedPoint } => {
|
): { fixedPoint: FixedPoint } => {
|
||||||
const bounds = [
|
const bounds = [
|
||||||
hoveredElement.x,
|
hoveredElement.x,
|
||||||
@@ -1896,12 +1916,20 @@ export const calculateFixedPointForElbowArrowBinding = (
|
|||||||
hoveredElement.x + hoveredElement.width,
|
hoveredElement.x + hoveredElement.width,
|
||||||
hoveredElement.y + hoveredElement.height,
|
hoveredElement.y + hoveredElement.height,
|
||||||
] as Bounds;
|
] as Bounds;
|
||||||
const snappedPoint = bindPointToSnapToElementOutline(
|
const snappedPoint = shouldSnapToOutline
|
||||||
linearElement,
|
? bindPointToSnapToElementOutline(
|
||||||
hoveredElement,
|
linearElement,
|
||||||
startOrEnd,
|
hoveredElement,
|
||||||
elementsMap,
|
startOrEnd,
|
||||||
);
|
elementsMap,
|
||||||
|
undefined,
|
||||||
|
isMidpointSnappingEnabled,
|
||||||
|
)
|
||||||
|
: LinearElementEditor.getPointAtIndexGlobalCoordinates(
|
||||||
|
linearElement,
|
||||||
|
startOrEnd === "start" ? 0 : -1,
|
||||||
|
elementsMap,
|
||||||
|
);
|
||||||
const globalMidPoint = pointFrom(
|
const globalMidPoint = pointFrom(
|
||||||
bounds[0] + (bounds[2] - bounds[0]) / 2,
|
bounds[0] + (bounds[2] - bounds[0]) / 2,
|
||||||
bounds[1] + (bounds[3] - bounds[1]) / 2,
|
bounds[1] + (bounds[3] - bounds[1]) / 2,
|
||||||
@@ -2447,21 +2475,37 @@ export const getArrowLocalFixedPoints = (
|
|||||||
];
|
];
|
||||||
};
|
};
|
||||||
|
|
||||||
export const normalizeFixedPoint = <T extends FixedPoint | null>(
|
export const isFixedPoint = (
|
||||||
|
fixedPoint: any,
|
||||||
|
): fixedPoint is FixedPointBinding["fixedPoint"] => {
|
||||||
|
return (
|
||||||
|
Array.isArray(fixedPoint) &&
|
||||||
|
fixedPoint.length === 2 &&
|
||||||
|
fixedPoint.every((coord) => Number.isFinite(coord))
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const normalizeFixedPoint = <T extends FixedPoint>(
|
||||||
fixedPoint: T,
|
fixedPoint: T,
|
||||||
): T extends null ? null : FixedPoint => {
|
): FixedPoint => {
|
||||||
|
if (!isFixedPoint(fixedPoint)) {
|
||||||
|
return [0.5001, 0.5001];
|
||||||
|
}
|
||||||
|
|
||||||
|
const EPSILON = 0.0001;
|
||||||
|
|
||||||
// Do not allow a precise 0.5 for fixed point ratio
|
// Do not allow a precise 0.5 for fixed point ratio
|
||||||
// to avoid jumping arrow heading due to floating point imprecision
|
// to avoid jumping arrow heading due to floating point imprecision
|
||||||
if (
|
if (
|
||||||
fixedPoint &&
|
Math.abs(fixedPoint[0] - 0.5) < EPSILON ||
|
||||||
(Math.abs(fixedPoint[0] - 0.5) < 0.0001 ||
|
Math.abs(fixedPoint[1] - 0.5) < EPSILON
|
||||||
Math.abs(fixedPoint[1] - 0.5) < 0.0001)
|
|
||||||
) {
|
) {
|
||||||
return fixedPoint.map((ratio) =>
|
return fixedPoint.map((ratio) =>
|
||||||
Math.abs(ratio - 0.5) < 0.0001 ? 0.5001 : ratio,
|
Math.abs(ratio - 0.5) < EPSILON ? 0.5001 : ratio,
|
||||||
) as T extends null ? null : FixedPoint;
|
) as FixedPoint;
|
||||||
}
|
}
|
||||||
return fixedPoint as any as T extends null ? null : FixedPoint;
|
|
||||||
|
return fixedPoint;
|
||||||
};
|
};
|
||||||
|
|
||||||
type Side =
|
type Side =
|
||||||
|
|||||||
@@ -78,12 +78,7 @@ import type {
|
|||||||
} from "./types";
|
} from "./types";
|
||||||
|
|
||||||
export const shouldTestInside = (element: ExcalidrawElement) => {
|
export const shouldTestInside = (element: ExcalidrawElement) => {
|
||||||
if (
|
if (element.type === "arrow") {
|
||||||
element.type === "arrow" ||
|
|
||||||
// frame elements should ignore inside hit test even if background is not
|
|
||||||
// transparent, so we can select children easily
|
|
||||||
isFrameLikeElement(element)
|
|
||||||
) {
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -915,6 +915,8 @@ export const updateElbowArrowPoints = (
|
|||||||
},
|
},
|
||||||
options?: {
|
options?: {
|
||||||
isDragging?: boolean;
|
isDragging?: boolean;
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
},
|
},
|
||||||
): ElementUpdate<ExcalidrawElbowArrowElement> => {
|
): ElementUpdate<ExcalidrawElbowArrowElement> => {
|
||||||
if (arrow.points.length < 2) {
|
if (arrow.points.length < 2) {
|
||||||
@@ -1202,6 +1204,8 @@ const getElbowArrowData = (
|
|||||||
options?: {
|
options?: {
|
||||||
isDragging?: boolean;
|
isDragging?: boolean;
|
||||||
zoom?: AppState["zoom"];
|
zoom?: AppState["zoom"];
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
},
|
},
|
||||||
) => {
|
) => {
|
||||||
const origStartGlobalPoint: GlobalPoint = pointTranslate<
|
const origStartGlobalPoint: GlobalPoint = pointTranslate<
|
||||||
@@ -1215,7 +1219,7 @@ const getElbowArrowData = (
|
|||||||
|
|
||||||
let hoveredStartElement = null;
|
let hoveredStartElement = null;
|
||||||
let hoveredEndElement = null;
|
let hoveredEndElement = null;
|
||||||
if (options?.isDragging) {
|
if (options?.isDragging && options?.isBindingEnabled !== false) {
|
||||||
const elements = Array.from(elementsMap.values());
|
const elements = Array.from(elementsMap.values());
|
||||||
hoveredStartElement =
|
hoveredStartElement =
|
||||||
getHoveredElement(
|
getHoveredElement(
|
||||||
@@ -1255,6 +1259,8 @@ const getElbowArrowData = (
|
|||||||
hoveredStartElement,
|
hoveredStartElement,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
options?.isDragging,
|
options?.isDragging,
|
||||||
|
options?.isBindingEnabled,
|
||||||
|
options?.isMidpointSnappingEnabled,
|
||||||
);
|
);
|
||||||
const endGlobalPoint = getGlobalPoint(
|
const endGlobalPoint = getGlobalPoint(
|
||||||
{
|
{
|
||||||
@@ -1270,6 +1276,8 @@ const getElbowArrowData = (
|
|||||||
hoveredEndElement,
|
hoveredEndElement,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
options?.isDragging,
|
options?.isDragging,
|
||||||
|
options?.isBindingEnabled,
|
||||||
|
options?.isMidpointSnappingEnabled,
|
||||||
);
|
);
|
||||||
const startHeading = getBindPointHeading(
|
const startHeading = getBindPointHeading(
|
||||||
startGlobalPoint,
|
startGlobalPoint,
|
||||||
@@ -2213,14 +2221,18 @@ const getGlobalPoint = (
|
|||||||
element?: ExcalidrawBindableElement | null,
|
element?: ExcalidrawBindableElement | null,
|
||||||
elementsMap?: ElementsMap,
|
elementsMap?: ElementsMap,
|
||||||
isDragging?: boolean,
|
isDragging?: boolean,
|
||||||
|
isBindingEnabled = true,
|
||||||
|
isMidpointSnappingEnabled = true,
|
||||||
): GlobalPoint => {
|
): GlobalPoint => {
|
||||||
if (isDragging) {
|
if (isDragging) {
|
||||||
if (element && elementsMap) {
|
if (isBindingEnabled && element && elementsMap) {
|
||||||
return bindPointToSnapToElementOutline(
|
return bindPointToSnapToElementOutline(
|
||||||
arrow,
|
arrow,
|
||||||
element,
|
element,
|
||||||
startOrEnd,
|
startOrEnd,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
|
undefined,
|
||||||
|
isMidpointSnappingEnabled,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -83,7 +83,6 @@ export * from "./positionElementsOnGrid";
|
|||||||
export * from "./renderElement";
|
export * from "./renderElement";
|
||||||
export * from "./resizeElements";
|
export * from "./resizeElements";
|
||||||
export * from "./resizeTest";
|
export * from "./resizeTest";
|
||||||
export * from "./schema";
|
|
||||||
export * from "./Scene";
|
export * from "./Scene";
|
||||||
export * from "./selection";
|
export * from "./selection";
|
||||||
export * from "./shape";
|
export * from "./shape";
|
||||||
|
|||||||
@@ -359,11 +359,20 @@ export class LinearElementEditor {
|
|||||||
linearElementEditor,
|
linearElementEditor,
|
||||||
);
|
);
|
||||||
|
|
||||||
LinearElementEditor.movePoints(element, app.scene, positions, {
|
LinearElementEditor.movePoints(
|
||||||
startBinding: updates?.startBinding,
|
element,
|
||||||
endBinding: updates?.endBinding,
|
app.scene,
|
||||||
moveMidPointsWithElement: updates?.moveMidPointsWithElement,
|
positions,
|
||||||
});
|
{
|
||||||
|
startBinding: updates?.startBinding,
|
||||||
|
endBinding: updates?.endBinding,
|
||||||
|
moveMidPointsWithElement: updates?.moveMidPointsWithElement,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
isBindingEnabled: app.state.isBindingEnabled,
|
||||||
|
isMidpointSnappingEnabled: app.state.isMidpointSnappingEnabled,
|
||||||
|
},
|
||||||
|
);
|
||||||
// Set the suggested binding from the updates if available
|
// Set the suggested binding from the updates if available
|
||||||
if (isBindingElement(element, false)) {
|
if (isBindingElement(element, false)) {
|
||||||
if (isBindingEnabled(app.state)) {
|
if (isBindingEnabled(app.state)) {
|
||||||
@@ -418,6 +427,7 @@ export class LinearElementEditor {
|
|||||||
"start",
|
"start",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
app.state.zoom,
|
app.state.zoom,
|
||||||
|
app.state.isMidpointSnappingEnabled,
|
||||||
)
|
)
|
||||||
: linearElementEditor.initialState.altFocusPoint,
|
: linearElementEditor.initialState.altFocusPoint,
|
||||||
},
|
},
|
||||||
@@ -538,11 +548,20 @@ export class LinearElementEditor {
|
|||||||
linearElementEditor,
|
linearElementEditor,
|
||||||
);
|
);
|
||||||
|
|
||||||
LinearElementEditor.movePoints(element, app.scene, positions, {
|
LinearElementEditor.movePoints(
|
||||||
startBinding: updates?.startBinding,
|
element,
|
||||||
endBinding: updates?.endBinding,
|
app.scene,
|
||||||
moveMidPointsWithElement: updates?.moveMidPointsWithElement,
|
positions,
|
||||||
});
|
{
|
||||||
|
startBinding: updates?.startBinding,
|
||||||
|
endBinding: updates?.endBinding,
|
||||||
|
moveMidPointsWithElement: updates?.moveMidPointsWithElement,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
isBindingEnabled: app.state.isBindingEnabled,
|
||||||
|
isMidpointSnappingEnabled: app.state.isMidpointSnappingEnabled,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
// Set the suggested binding from the updates if available
|
// Set the suggested binding from the updates if available
|
||||||
if (isBindingElement(element, false)) {
|
if (isBindingElement(element, false)) {
|
||||||
@@ -636,6 +655,7 @@ export class LinearElementEditor {
|
|||||||
"start",
|
"start",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
app.state.zoom,
|
app.state.zoom,
|
||||||
|
app.state.isMidpointSnappingEnabled,
|
||||||
)
|
)
|
||||||
: linearElementEditor.initialState.altFocusPoint,
|
: linearElementEditor.initialState.altFocusPoint,
|
||||||
},
|
},
|
||||||
@@ -1524,6 +1544,10 @@ export class LinearElementEditor {
|
|||||||
endBinding?: FixedPointBinding | null;
|
endBinding?: FixedPointBinding | null;
|
||||||
moveMidPointsWithElement?: boolean | null;
|
moveMidPointsWithElement?: boolean | null;
|
||||||
},
|
},
|
||||||
|
options?: {
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
|
},
|
||||||
) {
|
) {
|
||||||
const { points } = element;
|
const { points } = element;
|
||||||
|
|
||||||
@@ -1592,6 +1616,8 @@ export class LinearElementEditor {
|
|||||||
otherUpdates,
|
otherUpdates,
|
||||||
{
|
{
|
||||||
isDragging: Array.from(pointUpdates.values()).some((t) => t.isDragging),
|
isDragging: Array.from(pointUpdates.values()).some((t) => t.isDragging),
|
||||||
|
isBindingEnabled: options?.isBindingEnabled,
|
||||||
|
isMidpointSnappingEnabled: options?.isMidpointSnappingEnabled,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1706,6 +1732,8 @@ export class LinearElementEditor {
|
|||||||
isDragging?: boolean;
|
isDragging?: boolean;
|
||||||
zoom?: AppState["zoom"];
|
zoom?: AppState["zoom"];
|
||||||
sceneElementsMap?: NonDeletedSceneElementsMap;
|
sceneElementsMap?: NonDeletedSceneElementsMap;
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
},
|
},
|
||||||
) {
|
) {
|
||||||
if (isElbowArrow(element)) {
|
if (isElbowArrow(element)) {
|
||||||
@@ -1726,6 +1754,8 @@ export class LinearElementEditor {
|
|||||||
scene.mutateElement(element, updates, {
|
scene.mutateElement(element, updates, {
|
||||||
informMutation: true,
|
informMutation: true,
|
||||||
isDragging: options?.isDragging ?? false,
|
isDragging: options?.isDragging ?? false,
|
||||||
|
isBindingEnabled: options?.isBindingEnabled,
|
||||||
|
isMidpointSnappingEnabled: options?.isMidpointSnappingEnabled,
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
// TODO do we need to get precise coords here just to calc centers?
|
// TODO do we need to get precise coords here just to calc centers?
|
||||||
@@ -2145,14 +2175,16 @@ const pointDraggingUpdates = (
|
|||||||
suggestedBinding: suggestedBindingElement
|
suggestedBinding: suggestedBindingElement
|
||||||
? {
|
? {
|
||||||
element: suggestedBindingElement,
|
element: suggestedBindingElement,
|
||||||
midPoint: snapToMid(
|
midPoint: app.state.isMidpointSnappingEnabled
|
||||||
suggestedBindingElement,
|
? snapToMid(
|
||||||
elementsMap,
|
suggestedBindingElement,
|
||||||
pointFrom<GlobalPoint>(
|
elementsMap,
|
||||||
scenePointerX - linearElementEditor.pointerOffset.x,
|
pointFrom<GlobalPoint>(
|
||||||
scenePointerY - linearElementEditor.pointerOffset.y,
|
scenePointerX - linearElementEditor.pointerOffset.x,
|
||||||
),
|
scenePointerY - linearElementEditor.pointerOffset.y,
|
||||||
),
|
),
|
||||||
|
)
|
||||||
|
: undefined,
|
||||||
}
|
}
|
||||||
: null,
|
: null,
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ import type { Mutable } from "@excalidraw/common/utility-types";
|
|||||||
import { ShapeCache } from "./shape";
|
import { ShapeCache } from "./shape";
|
||||||
|
|
||||||
import { updateElbowArrowPoints } from "./elbowArrow";
|
import { updateElbowArrowPoints } from "./elbowArrow";
|
||||||
import { ensureSchemaStateForElementType } from "./schema";
|
|
||||||
|
|
||||||
import { isElbowArrow } from "./typeChecks";
|
import { isElbowArrow } from "./typeChecks";
|
||||||
|
|
||||||
@@ -41,6 +40,8 @@ export const mutateElement = <TElement extends Mutable<ExcalidrawElement>>(
|
|||||||
updates: ElementUpdate<TElement>,
|
updates: ElementUpdate<TElement>,
|
||||||
options?: {
|
options?: {
|
||||||
isDragging?: boolean;
|
isDragging?: boolean;
|
||||||
|
isBindingEnabled?: boolean;
|
||||||
|
isMidpointSnappingEnabled?: boolean;
|
||||||
},
|
},
|
||||||
) => {
|
) => {
|
||||||
let didChange = false;
|
let didChange = false;
|
||||||
@@ -138,10 +139,6 @@ export const mutateElement = <TElement extends Mutable<ExcalidrawElement>>(
|
|||||||
element.version = updates.version ?? element.version + 1;
|
element.version = updates.version ?? element.version + 1;
|
||||||
element.versionNonce = updates.versionNonce ?? randomInteger();
|
element.versionNonce = updates.versionNonce ?? randomInteger();
|
||||||
element.updated = getUpdatedTimestamp();
|
element.updated = getUpdatedTimestamp();
|
||||||
element.schemaState = ensureSchemaStateForElementType(
|
|
||||||
element.schemaState,
|
|
||||||
element.type,
|
|
||||||
) as TElement["schemaState"];
|
|
||||||
|
|
||||||
return element;
|
return element;
|
||||||
};
|
};
|
||||||
@@ -171,21 +168,13 @@ export const newElementWith = <TElement extends ExcalidrawElement>(
|
|||||||
return element;
|
return element;
|
||||||
}
|
}
|
||||||
|
|
||||||
const updatedElement = {
|
return {
|
||||||
...element,
|
...element,
|
||||||
...updates,
|
...updates,
|
||||||
version: updates.version ?? element.version + 1,
|
version: updates.version ?? element.version + 1,
|
||||||
versionNonce: updates.versionNonce ?? randomInteger(),
|
versionNonce: updates.versionNonce ?? randomInteger(),
|
||||||
updated: getUpdatedTimestamp(),
|
updated: getUpdatedTimestamp(),
|
||||||
};
|
};
|
||||||
|
|
||||||
return {
|
|
||||||
...updatedElement,
|
|
||||||
schemaState: ensureSchemaStateForElementType(
|
|
||||||
updatedElement.schemaState,
|
|
||||||
updatedElement.type,
|
|
||||||
),
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ import {
|
|||||||
getElementAbsoluteCoords,
|
getElementAbsoluteCoords,
|
||||||
getResizedElementAbsoluteCoords,
|
getResizedElementAbsoluteCoords,
|
||||||
} from "./bounds";
|
} from "./bounds";
|
||||||
import { ensureSchemaStateForElementType } from "./schema";
|
|
||||||
import { newElementWith } from "./mutateElement";
|
import { newElementWith } from "./mutateElement";
|
||||||
import { getBoundTextMaxWidth } from "./textElement";
|
import { getBoundTextMaxWidth } from "./textElement";
|
||||||
import { normalizeText, measureText } from "./textMeasurements";
|
import { normalizeText, measureText } from "./textMeasurements";
|
||||||
@@ -71,7 +70,6 @@ export type ElementConstructorOpts = MarkOptional<
|
|||||||
| "roughness"
|
| "roughness"
|
||||||
| "strokeWidth"
|
| "strokeWidth"
|
||||||
| "roundness"
|
| "roundness"
|
||||||
| "schemaState"
|
|
||||||
| "locked"
|
| "locked"
|
||||||
| "opacity"
|
| "opacity"
|
||||||
| "customData"
|
| "customData"
|
||||||
@@ -146,7 +144,6 @@ const _newElementBase = <T extends ExcalidrawElement>(
|
|||||||
roundness,
|
roundness,
|
||||||
seed: rest.seed ?? randomInteger(),
|
seed: rest.seed ?? randomInteger(),
|
||||||
version: rest.version || 1,
|
version: rest.version || 1,
|
||||||
schemaState: ensureSchemaStateForElementType(rest.schemaState, type),
|
|
||||||
versionNonce: rest.versionNonce ?? 0,
|
versionNonce: rest.versionNonce ?? 0,
|
||||||
isDeleted: false as false,
|
isDeleted: false as false,
|
||||||
boundElements,
|
boundElements,
|
||||||
|
|||||||
@@ -22,7 +22,6 @@ import {
|
|||||||
isRTL,
|
isRTL,
|
||||||
getVerticalOffset,
|
getVerticalOffset,
|
||||||
invariant,
|
invariant,
|
||||||
isTransparent,
|
|
||||||
applyDarkModeFilter,
|
applyDarkModeFilter,
|
||||||
isSafari,
|
isSafari,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
@@ -79,7 +78,6 @@ import type {
|
|||||||
ExcalidrawFrameLikeElement,
|
ExcalidrawFrameLikeElement,
|
||||||
NonDeletedSceneElementsMap,
|
NonDeletedSceneElementsMap,
|
||||||
ElementsMap,
|
ElementsMap,
|
||||||
ExcalidrawFrameElement,
|
|
||||||
} from "./types";
|
} from "./types";
|
||||||
|
|
||||||
import type { RoughCanvas } from "roughjs/bin/canvas";
|
import type { RoughCanvas } from "roughjs/bin/canvas";
|
||||||
@@ -779,45 +777,6 @@ export const renderSelectionElement = (
|
|||||||
context.restore();
|
context.restore();
|
||||||
};
|
};
|
||||||
|
|
||||||
export const renderFrameBackground = (
|
|
||||||
frame: ExcalidrawFrameElement,
|
|
||||||
context: CanvasRenderingContext2D,
|
|
||||||
appState: StaticCanvasAppState | InteractiveCanvasAppState,
|
|
||||||
opts?: {
|
|
||||||
roundCorners?: boolean;
|
|
||||||
},
|
|
||||||
) => {
|
|
||||||
if (isTransparent(frame.backgroundColor)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
context.save();
|
|
||||||
context.translate(frame.x + appState.scrollX, frame.y + appState.scrollY);
|
|
||||||
context.fillStyle =
|
|
||||||
appState.theme === THEME.DARK
|
|
||||||
? applyDarkModeFilter(frame.backgroundColor)
|
|
||||||
: frame.backgroundColor;
|
|
||||||
|
|
||||||
const shouldRoundCorners = opts?.roundCorners ?? true;
|
|
||||||
|
|
||||||
if (shouldRoundCorners && FRAME_STYLE.radius && context.roundRect) {
|
|
||||||
context.beginPath();
|
|
||||||
context.roundRect(
|
|
||||||
0,
|
|
||||||
0,
|
|
||||||
frame.width,
|
|
||||||
frame.height,
|
|
||||||
FRAME_STYLE.radius / appState.zoom.value,
|
|
||||||
);
|
|
||||||
context.fill();
|
|
||||||
context.closePath();
|
|
||||||
} else {
|
|
||||||
context.fillRect(0, 0, frame.width, frame.height);
|
|
||||||
}
|
|
||||||
|
|
||||||
context.restore();
|
|
||||||
};
|
|
||||||
|
|
||||||
export const renderElement = (
|
export const renderElement = (
|
||||||
element: NonDeletedExcalidrawElement,
|
element: NonDeletedExcalidrawElement,
|
||||||
elementsMap: RenderableElementsMap,
|
elementsMap: RenderableElementsMap,
|
||||||
@@ -849,6 +808,7 @@ export const renderElement = (
|
|||||||
element.x + appState.scrollX,
|
element.x + appState.scrollX,
|
||||||
element.y + appState.scrollY,
|
element.y + appState.scrollY,
|
||||||
);
|
);
|
||||||
|
context.fillStyle = "rgba(0, 0, 200, 0.04)";
|
||||||
|
|
||||||
context.lineWidth = FRAME_STYLE.strokeWidth / appState.zoom.value;
|
context.lineWidth = FRAME_STYLE.strokeWidth / appState.zoom.value;
|
||||||
context.strokeStyle =
|
context.strokeStyle =
|
||||||
|
|||||||
@@ -1,91 +0,0 @@
|
|||||||
/**
|
|
||||||
* Shared schema primitives used by element types and higher-level migrations.
|
|
||||||
*/
|
|
||||||
export const SCHEMA_INITIAL_TRACK_VERSION = 1 as const;
|
|
||||||
|
|
||||||
/** Core namespace reserved for built-in Excalidraw migrations. */
|
|
||||||
export const SCHEMA_CORE_NAMESPACE = "core" as const;
|
|
||||||
export type SchemaNamespace = typeof SCHEMA_CORE_NAMESPACE | `host.${string}`;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A schema track is an independent version line:
|
|
||||||
* - core tracks: "excalidraw.*"
|
|
||||||
* - host tracks: "host.<appId>.<track>"
|
|
||||||
*/
|
|
||||||
export type SchemaTrack = `excalidraw.${string}` | `host.${string}.${string}`;
|
|
||||||
export type ElementSchemaState = Readonly<{
|
|
||||||
tracks: Readonly<Record<string, number>>;
|
|
||||||
}>;
|
|
||||||
|
|
||||||
/** Core frame track id used by the frame background migration. */
|
|
||||||
export const CORE_FRAME_SCHEMA_TRACK = "excalidraw.shape.frame" as const;
|
|
||||||
|
|
||||||
/** Latest core track versions supported by this build. */
|
|
||||||
export const CORE_SUPPORTED_TRACKS = {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]: 2,
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
const getRequiredCoreTracksForElementType = (type: string) => {
|
|
||||||
if (type === "frame") {
|
|
||||||
return {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]: CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
} as const;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {} as const;
|
|
||||||
};
|
|
||||||
|
|
||||||
const isValidTrackVersion = (version: unknown): version is number =>
|
|
||||||
typeof version === "number" &&
|
|
||||||
Number.isInteger(version) &&
|
|
||||||
version >= SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Ensures an element schema state is normalized and satisfies type defaults.
|
|
||||||
* Required core tracks are only ever bumped forward (never downgraded).
|
|
||||||
*/
|
|
||||||
export const ensureSchemaStateForElementType = (
|
|
||||||
schemaState: ElementSchemaState | undefined,
|
|
||||||
type: string,
|
|
||||||
): ElementSchemaState => {
|
|
||||||
const requiredTracks = getRequiredCoreTracksForElementType(type);
|
|
||||||
const currentTracks = schemaState?.tracks || {};
|
|
||||||
const nextTracks: Record<string, number> = {};
|
|
||||||
let didChange = !schemaState;
|
|
||||||
|
|
||||||
for (const [track, version] of Object.entries(
|
|
||||||
currentTracks as Record<string, unknown>,
|
|
||||||
)) {
|
|
||||||
if (isValidTrackVersion(version)) {
|
|
||||||
nextTracks[track] = version;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
nextTracks[track] = SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
didChange = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const [track, requiredVersion] of Object.entries(requiredTracks)) {
|
|
||||||
const currentVersion = nextTracks[track];
|
|
||||||
if (
|
|
||||||
!isValidTrackVersion(currentVersion) ||
|
|
||||||
currentVersion < requiredVersion
|
|
||||||
) {
|
|
||||||
nextTracks[track] = requiredVersion;
|
|
||||||
didChange = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!didChange) {
|
|
||||||
return schemaState!;
|
|
||||||
}
|
|
||||||
|
|
||||||
return { tracks: nextTracks };
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Default schema state for newly created elements.
|
|
||||||
* New frames are created at the latest supported frame track version.
|
|
||||||
*/
|
|
||||||
export const getDefaultSchemaStateForElementType = (
|
|
||||||
type: string,
|
|
||||||
): ElementSchemaState => ensureSchemaStateForElementType(undefined, type);
|
|
||||||
@@ -15,9 +15,7 @@ import type {
|
|||||||
ValueOf,
|
ValueOf,
|
||||||
} from "@excalidraw/common/utility-types";
|
} from "@excalidraw/common/utility-types";
|
||||||
|
|
||||||
import type { ElementSchemaState } from "./schema";
|
export type ChartType = "bar" | "line" | "radar";
|
||||||
|
|
||||||
export type ChartType = "bar" | "line";
|
|
||||||
export type FillStyle = "hachure" | "cross-hatch" | "solid" | "zigzag";
|
export type FillStyle = "hachure" | "cross-hatch" | "solid" | "zigzag";
|
||||||
export type FontFamilyKeys = keyof typeof FONT_FAMILY;
|
export type FontFamilyKeys = keyof typeof FONT_FAMILY;
|
||||||
export type FontFamilyValues = typeof FONT_FAMILY[FontFamilyKeys];
|
export type FontFamilyValues = typeof FONT_FAMILY[FontFamilyKeys];
|
||||||
@@ -60,8 +58,6 @@ type _ExcalidrawElementBase = Readonly<{
|
|||||||
/** Integer that is sequentially incremented on each change. Used to reconcile
|
/** Integer that is sequentially incremented on each change. Used to reconcile
|
||||||
elements during collaboration or when saving to server. */
|
elements during collaboration or when saving to server. */
|
||||||
version: number;
|
version: number;
|
||||||
/** Per-track schema state used by migrations during restore. */
|
|
||||||
schemaState: ElementSchemaState;
|
|
||||||
/** Random integer that is regenerated on each change.
|
/** Random integer that is regenerated on each change.
|
||||||
Used for deterministic reconciliation of updates during collaboration,
|
Used for deterministic reconciliation of updates during collaboration,
|
||||||
in case the versions (see above) are identical. */
|
in case the versions (see above) are identical. */
|
||||||
|
|||||||
@@ -659,20 +659,23 @@ export const projectFixedPointOntoDiagonal = (
|
|||||||
startOrEnd: "start" | "end",
|
startOrEnd: "start" | "end",
|
||||||
elementsMap: ElementsMap,
|
elementsMap: ElementsMap,
|
||||||
zoom: AppState["zoom"],
|
zoom: AppState["zoom"],
|
||||||
|
isMidpointSnappingEnabled: boolean = true,
|
||||||
): GlobalPoint | null => {
|
): GlobalPoint | null => {
|
||||||
invariant(arrow.points.length >= 2, "Arrow must have at least two points");
|
invariant(arrow.points.length >= 2, "Arrow must have at least two points");
|
||||||
if (arrow.width < 3 && arrow.height < 3) {
|
if (arrow.width < 3 && arrow.height < 3) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const sideMidPoint = getSnapOutlineMidPoint(
|
if (isMidpointSnappingEnabled) {
|
||||||
point,
|
const sideMidPoint = getSnapOutlineMidPoint(
|
||||||
element,
|
point,
|
||||||
elementsMap,
|
element,
|
||||||
zoom,
|
elementsMap,
|
||||||
);
|
zoom,
|
||||||
if (sideMidPoint) {
|
);
|
||||||
return sideMidPoint;
|
if (sideMidPoint) {
|
||||||
|
return sideMidPoint;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Do the projection onto the diagonals (or center lines
|
// Do the projection onto the diagonals (or center lines
|
||||||
|
|||||||
@@ -38,53 +38,6 @@ describe("check rotated elements can be hit:", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("frame hit testing", () => {
|
|
||||||
it.each(["transparent", "#ffffff"])(
|
|
||||||
"does not hit frame inside regardless of background color (%s)",
|
|
||||||
(backgroundColor) => {
|
|
||||||
const element = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
x: 0,
|
|
||||||
y: 0,
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
backgroundColor,
|
|
||||||
});
|
|
||||||
const elementsMap = arrayToMap([element]);
|
|
||||||
|
|
||||||
expect(
|
|
||||||
hitElementItself({
|
|
||||||
point: pointFrom<GlobalPoint>(50, 50),
|
|
||||||
element,
|
|
||||||
threshold: 10,
|
|
||||||
elementsMap,
|
|
||||||
}),
|
|
||||||
).toBe(false);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
it("hits frame outline", () => {
|
|
||||||
const element = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
x: 0,
|
|
||||||
y: 0,
|
|
||||||
width: 100,
|
|
||||||
height: 100,
|
|
||||||
backgroundColor: "#ffffff",
|
|
||||||
});
|
|
||||||
const elementsMap = arrayToMap([element]);
|
|
||||||
|
|
||||||
expect(
|
|
||||||
hitElementItself({
|
|
||||||
point: pointFrom<GlobalPoint>(0, 50),
|
|
||||||
element,
|
|
||||||
threshold: 1,
|
|
||||||
elementsMap,
|
|
||||||
}),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("hitElementItself cache", () => {
|
describe("hitElementItself cache", () => {
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
// reset cache
|
// reset cache
|
||||||
|
|||||||
@@ -11,6 +11,92 @@ The change should be grouped under one of the below section and must contain PR
|
|||||||
Please add the latest change on the top under the correct section.
|
Please add the latest change on the top under the correct section.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
## Excalidraw API
|
||||||
|
|
||||||
|
### Breaking changes
|
||||||
|
|
||||||
|
- Renamed the `excalidrawAPI` prop to `onExcalidrawAPI`.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Added `onMount` and `onInitialize` props. `onMount` receives `{ excalidrawAPI, container }` once the editor root is mounted, and `onInitialize` fires once the initial scene has loaded.
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
<Excalidraw
|
||||||
|
onMount={({ excalidrawAPI, container }) => {
|
||||||
|
console.log(container);
|
||||||
|
excalidrawAPI.scrollToContent();
|
||||||
|
}}
|
||||||
|
onInitialize={(api) => {
|
||||||
|
api.refresh();
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
- Same events are also accessible imperatively through `api.onEvent(...)`.
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
<Excalidraw
|
||||||
|
onExcalidrawAPI={(api) => {
|
||||||
|
api.onEvent("editor:mount", ({ excalidrawAPI, container }) => {
|
||||||
|
excalidrawAPI.scrollToContent();
|
||||||
|
console.log(container);
|
||||||
|
});
|
||||||
|
|
||||||
|
api.onEvent("editor:initialize").then((readyApi) => {
|
||||||
|
readyApi.scrollToContent();
|
||||||
|
});
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that in future releases, most, if not all, `excalidrawAPI.on*` subscriptions will be removed in favor of `excalidrawAPI.onEvent(name)`.
|
||||||
|
|
||||||
|
- Exported `ExcalidrawAPIProvider`, `useExcalidrawAPI`, and `useAppStateValue` from the package entrypoint. The imperative API also now exposes `onStateChange`.
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
<ExcalidrawAPIProvider>
|
||||||
|
<Excalidraw />
|
||||||
|
<Logger />
|
||||||
|
</ExcalidrawAPIProvider>;
|
||||||
|
|
||||||
|
function Logger() {
|
||||||
|
const api = useExcalidrawAPI();
|
||||||
|
|
||||||
|
useAppStateValue("viewModeEnabled", (viewModeEnabled) => {
|
||||||
|
console.log("view mode changed:", viewModeEnabled);
|
||||||
|
});
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (api) {
|
||||||
|
console.log("editor instance id:", api.id);
|
||||||
|
}
|
||||||
|
}, [api]);
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Added `onExport` so host apps can delay JSON export until async work completes. The handler receives the export data plus an `AbortSignal`, and may return a `Promise` or an async generator that yields progress updates for the built-in toast UI.
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
<Excalidraw
|
||||||
|
onExport={async function* (_type, { files }, { signal }) {
|
||||||
|
yield { type: "progress", message: "Waiting for images..." };
|
||||||
|
|
||||||
|
await waitForImagesToLoad(files, signal);
|
||||||
|
|
||||||
|
if (signal.aborted) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
yield { type: "progress", message: "Export ready", progress: 1 };
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
## Excalidraw Library
|
## Excalidraw Library
|
||||||
|
|
||||||
## 0.18.0 (2025-03-11)
|
## 0.18.0 (2025-03-11)
|
||||||
|
|||||||
@@ -118,7 +118,6 @@ export const actionClearCanvas = register({
|
|||||||
gridStep: appState.gridStep,
|
gridStep: appState.gridStep,
|
||||||
gridModeEnabled: appState.gridModeEnabled,
|
gridModeEnabled: appState.gridModeEnabled,
|
||||||
stats: appState.stats,
|
stats: appState.stats,
|
||||||
pasteDialog: appState.pasteDialog,
|
|
||||||
activeTool:
|
activeTool:
|
||||||
appState.activeTool.type === "image"
|
appState.activeTool.type === "image"
|
||||||
? {
|
? {
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ import { getSelectedElements, isSomeElementSelected } from "../scene";
|
|||||||
import { TrashIcon } from "../components/icons";
|
import { TrashIcon } from "../components/icons";
|
||||||
import { ToolButton } from "../components/ToolButton";
|
import { ToolButton } from "../components/ToolButton";
|
||||||
|
|
||||||
import { useStylesPanelMode } from "..";
|
import { useStylesPanelMode } from "../components/App";
|
||||||
|
|
||||||
import { register } from "./register";
|
import { register } from "./register";
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ import { t } from "../i18n";
|
|||||||
import { isSomeElementSelected } from "../scene";
|
import { isSomeElementSelected } from "../scene";
|
||||||
import { getShortcutKey } from "../shortcut";
|
import { getShortcutKey } from "../shortcut";
|
||||||
|
|
||||||
import { useStylesPanelMode } from "..";
|
import { useStylesPanelMode } from "../components/App";
|
||||||
|
|
||||||
import { register } from "./register";
|
import { register } from "./register";
|
||||||
|
|
||||||
|
|||||||
@@ -9,18 +9,20 @@ import { getNonDeletedElements } from "@excalidraw/element";
|
|||||||
|
|
||||||
import { CaptureUpdateAction } from "@excalidraw/element";
|
import { CaptureUpdateAction } from "@excalidraw/element";
|
||||||
|
|
||||||
import type { Theme } from "@excalidraw/element/types";
|
import type { ExcalidrawElement, Theme } from "@excalidraw/element/types";
|
||||||
|
|
||||||
import { useEditorInterface } from "../components/App";
|
import { useEditorInterface } from "../components/App";
|
||||||
import { CheckboxItem } from "../components/CheckboxItem";
|
import { CheckboxItem } from "../components/CheckboxItem";
|
||||||
import { DarkModeToggle } from "../components/DarkModeToggle";
|
import { DarkModeToggle } from "../components/DarkModeToggle";
|
||||||
import { ProjectName } from "../components/ProjectName";
|
import { ProjectName } from "../components/ProjectName";
|
||||||
|
import { Toast } from "../components/Toast";
|
||||||
import { ToolButton } from "../components/ToolButton";
|
import { ToolButton } from "../components/ToolButton";
|
||||||
import { Tooltip } from "../components/Tooltip";
|
import { Tooltip } from "../components/Tooltip";
|
||||||
import { ExportIcon, questionCircle, saveAs } from "../components/icons";
|
import { ExportIcon, questionCircle, saveAs } from "../components/icons";
|
||||||
import { loadFromJSON, saveAsJSON } from "../data";
|
import { loadFromJSON, saveAsJSON } from "../data";
|
||||||
import { isImageFileHandle } from "../data/blob";
|
import { isImageFileHandle } from "../data/blob";
|
||||||
import { nativeFileSystemSupported } from "../data/filesystem";
|
import { nativeFileSystemSupported } from "../data/filesystem";
|
||||||
|
|
||||||
import { resaveAsImageWithScene } from "../data/resave";
|
import { resaveAsImageWithScene } from "../data/resave";
|
||||||
|
|
||||||
import { t } from "../i18n";
|
import { t } from "../i18n";
|
||||||
@@ -31,7 +33,15 @@ import "../components/ToolIcon.scss";
|
|||||||
|
|
||||||
import { register } from "./register";
|
import { register } from "./register";
|
||||||
|
|
||||||
import type { AppState } from "../types";
|
import type { JSONExportData } from "../data/json";
|
||||||
|
|
||||||
|
import type {
|
||||||
|
AppClassProperties,
|
||||||
|
AppState,
|
||||||
|
BinaryFiles,
|
||||||
|
ExcalidrawProps,
|
||||||
|
OnExportProgress,
|
||||||
|
} from "../types";
|
||||||
|
|
||||||
export const actionChangeProjectName = register<AppState["name"]>({
|
export const actionChangeProjectName = register<AppState["name"]>({
|
||||||
name: "changeProjectName",
|
name: "changeProjectName",
|
||||||
@@ -150,6 +160,143 @@ export const actionChangeExportEmbedScene = register<
|
|||||||
),
|
),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// onExport interception helpers
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
let onExportInProgress = false;
|
||||||
|
|
||||||
|
const onProgressToast = (
|
||||||
|
app: AppClassProperties,
|
||||||
|
progress: {
|
||||||
|
message?: OnExportProgress["message"];
|
||||||
|
progress?: number | null;
|
||||||
|
},
|
||||||
|
) => {
|
||||||
|
const message = progress.message ?? t("progressDialog.defaultMessage");
|
||||||
|
app.setAppState({
|
||||||
|
toast: {
|
||||||
|
message:
|
||||||
|
progress.progress != null ? (
|
||||||
|
<>
|
||||||
|
{message}
|
||||||
|
<Toast.ProgressBar progress={progress.progress} />
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
message
|
||||||
|
),
|
||||||
|
duration: Infinity,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
/** awaits host app's onExport result, and renders progress to the UI */
|
||||||
|
async function handleOnExportResult(
|
||||||
|
onExportResult: ReturnType<NonNullable<ExcalidrawProps["onExport"]>>,
|
||||||
|
opts: {
|
||||||
|
signal: AbortSignal;
|
||||||
|
app: AppClassProperties;
|
||||||
|
},
|
||||||
|
): Promise<void> {
|
||||||
|
if (opts.app.state.isLoading) {
|
||||||
|
onProgressToast(opts.app, { progress: null });
|
||||||
|
await opts.app.onStateChange({ predicate: (state) => !state.isLoading });
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
onExportResult != null &&
|
||||||
|
typeof onExportResult === "object" &&
|
||||||
|
Symbol.asyncIterator in onExportResult
|
||||||
|
) {
|
||||||
|
for await (const value of onExportResult) {
|
||||||
|
if (opts.signal.aborted) {
|
||||||
|
onExportResult.return();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (value.type === "progress") {
|
||||||
|
onProgressToast(opts.app, {
|
||||||
|
message: value.message,
|
||||||
|
progress: value.progress ?? null,
|
||||||
|
});
|
||||||
|
} else if (value.type === "done") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generator completed without explicit "done" message
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (onExportResult instanceof Promise) {
|
||||||
|
onProgressToast(opts.app, { progress: null });
|
||||||
|
await onExportResult;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function prepareDataForJSONExport(
|
||||||
|
elements: readonly ExcalidrawElement[],
|
||||||
|
appState: AppState,
|
||||||
|
files: BinaryFiles,
|
||||||
|
app: AppClassProperties,
|
||||||
|
): { abortController: AbortController; data: Promise<JSONExportData> } {
|
||||||
|
const abortController = new AbortController();
|
||||||
|
const signal = abortController.signal;
|
||||||
|
|
||||||
|
const dataPromise = new Promise<JSONExportData>(async (resolve) => {
|
||||||
|
try {
|
||||||
|
if (app.props.onExport) {
|
||||||
|
await handleOnExportResult(
|
||||||
|
app.props.onExport(
|
||||||
|
"json",
|
||||||
|
{
|
||||||
|
elements,
|
||||||
|
appState,
|
||||||
|
files,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
signal,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
{
|
||||||
|
app,
|
||||||
|
signal,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} catch (error: any) {
|
||||||
|
if (error?.name === "AbortError") {
|
||||||
|
// if abort error, assume it's a reaction on the signal being aborted
|
||||||
|
console.warn(
|
||||||
|
`onExport() aborted by host app (signal aborted: ${signal.aborted})`,
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
// non-abort error
|
||||||
|
//
|
||||||
|
console.error("Error during props.onExport() handling", error);
|
||||||
|
}
|
||||||
|
|
||||||
|
// either way, we currently don't allow host apps to cancel save actions
|
||||||
|
// so we resolve to orig data
|
||||||
|
}
|
||||||
|
|
||||||
|
resolve({
|
||||||
|
elements,
|
||||||
|
appState,
|
||||||
|
// return latest files in case they finished loading during onExport
|
||||||
|
files: app.files,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
abortController,
|
||||||
|
data: dataPromise,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Save actions
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
export const actionSaveToActiveFile = register({
|
export const actionSaveToActiveFile = register({
|
||||||
name: "saveToActiveFile",
|
name: "saveToActiveFile",
|
||||||
label: "buttons.save",
|
label: "buttons.save",
|
||||||
@@ -163,42 +310,62 @@ export const actionSaveToActiveFile = register({
|
|||||||
);
|
);
|
||||||
},
|
},
|
||||||
perform: async (elements, appState, value, app) => {
|
perform: async (elements, appState, value, app) => {
|
||||||
const fileHandleExists = !!appState.fileHandle;
|
if (onExportInProgress) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
onExportInProgress = true;
|
||||||
|
|
||||||
|
const previousFileHandle = appState.fileHandle;
|
||||||
|
const filename = app.getName();
|
||||||
|
|
||||||
|
const { abortController, data: exportedDataPromise } =
|
||||||
|
prepareDataForJSONExport(elements, appState, app.files, app);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { fileHandle } = isImageFileHandle(appState.fileHandle)
|
const { fileHandle } = isImageFileHandle(previousFileHandle)
|
||||||
? await resaveAsImageWithScene(
|
? await resaveAsImageWithScene(
|
||||||
elements,
|
exportedDataPromise,
|
||||||
appState,
|
previousFileHandle,
|
||||||
app.files,
|
filename,
|
||||||
app.getName(),
|
|
||||||
)
|
)
|
||||||
: await saveAsJSON(elements, appState, app.files, app.getName());
|
: await saveAsJSON({
|
||||||
|
data: exportedDataPromise,
|
||||||
|
filename,
|
||||||
|
fileHandle: previousFileHandle,
|
||||||
|
});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
captureUpdate: CaptureUpdateAction.EVENTUALLY,
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
appState: {
|
appState: {
|
||||||
...appState,
|
|
||||||
fileHandle,
|
fileHandle,
|
||||||
toast: fileHandleExists
|
toast: {
|
||||||
? {
|
message:
|
||||||
message: fileHandle?.name
|
previousFileHandle && fileHandle?.name
|
||||||
? t("toast.fileSavedToFilename").replace(
|
? t("toast.fileSavedToFilename").replace(
|
||||||
"{filename}",
|
"{filename}",
|
||||||
`"${fileHandle.name}"`,
|
`"${fileHandle.name}"`,
|
||||||
)
|
)
|
||||||
: t("toast.fileSaved"),
|
: t("toast.fileSaved"),
|
||||||
}
|
duration: 1500,
|
||||||
: null,
|
},
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
|
abortController.abort();
|
||||||
|
|
||||||
if (error?.name !== "AbortError") {
|
if (error?.name !== "AbortError") {
|
||||||
console.error(error);
|
console.error(error);
|
||||||
} else {
|
} else {
|
||||||
console.warn(error);
|
console.warn(error);
|
||||||
}
|
}
|
||||||
return { captureUpdate: CaptureUpdateAction.EVENTUALLY };
|
return {
|
||||||
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
|
appState: {
|
||||||
|
toast: null,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
onExportInProgress = false;
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
keyTest: (event) =>
|
keyTest: (event) =>
|
||||||
@@ -212,36 +379,50 @@ export const actionSaveFileToDisk = register({
|
|||||||
viewMode: true,
|
viewMode: true,
|
||||||
trackEvent: { category: "export" },
|
trackEvent: { category: "export" },
|
||||||
perform: async (elements, appState, value, app) => {
|
perform: async (elements, appState, value, app) => {
|
||||||
|
if (onExportInProgress) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
onExportInProgress = true;
|
||||||
|
|
||||||
|
const { abortController, data: exportedDataPromise } =
|
||||||
|
prepareDataForJSONExport(elements, appState, app.files, app);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { fileHandle } = await saveAsJSON(
|
const { fileHandle: savedFileHandle } = await saveAsJSON({
|
||||||
elements,
|
data: exportedDataPromise,
|
||||||
{
|
filename: app.getName(),
|
||||||
...appState,
|
fileHandle: null,
|
||||||
fileHandle: null,
|
});
|
||||||
},
|
|
||||||
app.files,
|
|
||||||
app.getName(),
|
|
||||||
);
|
|
||||||
return {
|
return {
|
||||||
captureUpdate: CaptureUpdateAction.EVENTUALLY,
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
appState: {
|
appState: {
|
||||||
...appState,
|
|
||||||
openDialog: null,
|
openDialog: null,
|
||||||
fileHandle,
|
fileHandle: savedFileHandle,
|
||||||
toast: { message: t("toast.fileSaved") },
|
toast: { message: t("toast.fileSaved") },
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
|
abortController.abort();
|
||||||
if (error?.name !== "AbortError") {
|
if (error?.name !== "AbortError") {
|
||||||
console.error(error);
|
console.error(error);
|
||||||
} else {
|
} else {
|
||||||
console.warn(error);
|
console.warn(error);
|
||||||
}
|
}
|
||||||
return { captureUpdate: CaptureUpdateAction.EVENTUALLY };
|
return {
|
||||||
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
|
appState: {
|
||||||
|
toast: null,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
onExportInProgress = false;
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
keyTest: (event) =>
|
keyTest: (event) =>
|
||||||
event.key === KEYS.S && event.shiftKey && event[KEYS.CTRL_OR_CMD],
|
event.key.toLowerCase() === KEYS.S &&
|
||||||
|
event.shiftKey &&
|
||||||
|
event[KEYS.CTRL_OR_CMD],
|
||||||
PanelComponent: ({ updateData }) => (
|
PanelComponent: ({ updateData }) => (
|
||||||
<ToolButton
|
<ToolButton
|
||||||
type="button"
|
type="button"
|
||||||
@@ -271,11 +452,7 @@ export const actionLoadScene = register({
|
|||||||
elements: loadedElements,
|
elements: loadedElements,
|
||||||
appState: loadedAppState,
|
appState: loadedAppState,
|
||||||
files,
|
files,
|
||||||
} = await loadFromJSON(
|
} = await loadFromJSON(appState, elements);
|
||||||
appState,
|
|
||||||
elements,
|
|
||||||
app.getSchemaMigrationRegistry(),
|
|
||||||
);
|
|
||||||
return {
|
return {
|
||||||
elements: loadedElements,
|
elements: loadedElements,
|
||||||
appState: loadedAppState,
|
appState: loadedAppState,
|
||||||
@@ -304,7 +481,8 @@ export const actionExportWithDarkMode = register<
|
|||||||
name: "exportWithDarkMode",
|
name: "exportWithDarkMode",
|
||||||
label: "imageExportDialog.label.darkMode",
|
label: "imageExportDialog.label.darkMode",
|
||||||
trackEvent: { category: "export", action: "toggleTheme" },
|
trackEvent: { category: "export", action: "toggleTheme" },
|
||||||
perform: (_elements, appState, value) => {
|
perform: (_elements, appState, value, app) => {
|
||||||
|
app.sessionExportThemeOverride = value ? THEME.DARK : THEME.LIGHT;
|
||||||
return {
|
return {
|
||||||
appState: { ...appState, exportWithDarkMode: value },
|
appState: { ...appState, exportWithDarkMode: value },
|
||||||
captureUpdate: CaptureUpdateAction.EVENTUALLY,
|
captureUpdate: CaptureUpdateAction.EVENTUALLY,
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ import { HistoryChangedEvent } from "../history";
|
|||||||
import { useEmitter } from "../hooks/useEmitter";
|
import { useEmitter } from "../hooks/useEmitter";
|
||||||
import { t } from "../i18n";
|
import { t } from "../i18n";
|
||||||
|
|
||||||
import { useStylesPanelMode } from "..";
|
import { useStylesPanelMode } from "../components/App";
|
||||||
|
|
||||||
import type { History } from "../history";
|
import type { History } from "../history";
|
||||||
import type { AppClassProperties, AppState } from "../types";
|
import type { AppClassProperties, AppState } from "../types";
|
||||||
|
|||||||
@@ -6,23 +6,11 @@ import {
|
|||||||
FONT_FAMILY,
|
FONT_FAMILY,
|
||||||
STROKE_WIDTH,
|
STROKE_WIDTH,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
import {
|
|
||||||
CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
CORE_SUPPORTED_TRACKS,
|
|
||||||
} from "@excalidraw/element";
|
|
||||||
|
|
||||||
import { Excalidraw } from "../index";
|
import { Excalidraw } from "../index";
|
||||||
import { API } from "../tests/helpers/api";
|
import { API } from "../tests/helpers/api";
|
||||||
import { UI } from "../tests/helpers/ui";
|
import { UI } from "../tests/helpers/ui";
|
||||||
import { act, render } from "../tests/test-utils";
|
import { render } from "../tests/test-utils";
|
||||||
|
|
||||||
import {
|
|
||||||
actionChangeBackgroundColor,
|
|
||||||
actionChangeRoundness,
|
|
||||||
actionChangeStrokeWidth,
|
|
||||||
} from "./actionProperties";
|
|
||||||
|
|
||||||
const { h } = window;
|
|
||||||
|
|
||||||
describe("element locking", () => {
|
describe("element locking", () => {
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
@@ -121,21 +109,6 @@ describe("element locking", () => {
|
|||||||
expect(crossHatchButton).toBe(null);
|
expect(crossHatchButton).toBe(null);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should show background color picker for selected frame", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
});
|
|
||||||
API.setElements([frame]);
|
|
||||||
API.setSelectedElements([frame]);
|
|
||||||
|
|
||||||
expect(
|
|
||||||
queryByTestId(
|
|
||||||
document.body,
|
|
||||||
`color-top-pick-${DEFAULT_ELEMENT_BACKGROUND_PICKS[0]}`,
|
|
||||||
),
|
|
||||||
).not.toBe(null);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should highlight common stroke width of selected elements", () => {
|
it("should highlight common stroke width of selected elements", () => {
|
||||||
const rect1 = API.createElement({
|
const rect1 = API.createElement({
|
||||||
type: "rectangle",
|
type: "rectangle",
|
||||||
@@ -196,77 +169,5 @@ describe("element locking", () => {
|
|||||||
"active",
|
"active",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should not update text background when changing background in mixed frame selection", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
schemaState: { tracks: {} },
|
|
||||||
});
|
|
||||||
const text = API.createElement({
|
|
||||||
type: "text",
|
|
||||||
backgroundColor: COLOR_PALETTE.transparent,
|
|
||||||
});
|
|
||||||
API.setElements([text, frame]);
|
|
||||||
API.setSelectedElements([text, frame]);
|
|
||||||
|
|
||||||
act(() => {
|
|
||||||
h.app.actionManager.executeAction(actionChangeBackgroundColor, "ui", {
|
|
||||||
viewBackgroundColor: h.state.viewBackgroundColor,
|
|
||||||
currentItemBackgroundColor: "#ffc9c9",
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(API.getElement(frame).backgroundColor).toBe("#ffc9c9");
|
|
||||||
expect(API.getElement(text).backgroundColor).toBe(
|
|
||||||
COLOR_PALETTE.transparent,
|
|
||||||
);
|
|
||||||
expect(
|
|
||||||
API.getElement(frame).schemaState.tracks[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
).toBe(CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should not update frame stroke width when changing stroke width in mixed selection", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
});
|
|
||||||
const rect = API.createElement({
|
|
||||||
type: "rectangle",
|
|
||||||
strokeWidth: STROKE_WIDTH.thin,
|
|
||||||
});
|
|
||||||
API.setElements([rect, frame]);
|
|
||||||
API.setSelectedElements([rect, frame]);
|
|
||||||
|
|
||||||
const originalFrameStrokeWidth = API.getElement(frame).strokeWidth;
|
|
||||||
|
|
||||||
act(() => {
|
|
||||||
h.app.actionManager.executeAction(
|
|
||||||
actionChangeStrokeWidth,
|
|
||||||
"ui",
|
|
||||||
STROKE_WIDTH.extraBold,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(API.getElement(rect).strokeWidth).toBe(STROKE_WIDTH.extraBold);
|
|
||||||
expect(API.getElement(frame).strokeWidth).toBe(originalFrameStrokeWidth);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should not update frame roundness when changing roundness in mixed selection", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
});
|
|
||||||
const rect = API.createElement({
|
|
||||||
type: "rectangle",
|
|
||||||
roundness: null,
|
|
||||||
});
|
|
||||||
API.setElements([rect, frame]);
|
|
||||||
API.setSelectedElements([rect, frame]);
|
|
||||||
|
|
||||||
act(() => {
|
|
||||||
h.app.actionManager.executeAction(actionChangeRoundness, "ui", "round");
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(API.getElement(rect).roundness).not.toBe(null);
|
|
||||||
expect(API.getElement(frame).roundness).toBe(null);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -45,7 +45,6 @@ import {
|
|||||||
import {
|
import {
|
||||||
isArrowElement,
|
isArrowElement,
|
||||||
isBoundToContainer,
|
isBoundToContainer,
|
||||||
isFrameElement,
|
|
||||||
isElbowArrow,
|
isElbowArrow,
|
||||||
isLinearElement,
|
isLinearElement,
|
||||||
isLineElement,
|
isLineElement,
|
||||||
@@ -53,13 +52,7 @@ import {
|
|||||||
isUsingAdaptiveRadius,
|
isUsingAdaptiveRadius,
|
||||||
} from "@excalidraw/element";
|
} from "@excalidraw/element";
|
||||||
|
|
||||||
import {
|
import { hasStrokeColor } from "@excalidraw/element";
|
||||||
canChangeRoundness,
|
|
||||||
hasBackground,
|
|
||||||
hasStrokeColor,
|
|
||||||
hasStrokeStyle,
|
|
||||||
hasStrokeWidth,
|
|
||||||
} from "@excalidraw/element";
|
|
||||||
|
|
||||||
import {
|
import {
|
||||||
updateElbowArrowPoints,
|
updateElbowArrowPoints,
|
||||||
@@ -416,18 +409,11 @@ export const actionChangeBackgroundColor = register<
|
|||||||
return el;
|
return el;
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
nextElements = changeProperty(elements, appState, (el) => {
|
nextElements = changeProperty(elements, appState, (el) =>
|
||||||
if (isFrameElement(el)) {
|
newElementWith(el, {
|
||||||
return newElementWith(el, {
|
backgroundColor: value.currentItemBackgroundColor,
|
||||||
backgroundColor: value.currentItemBackgroundColor,
|
}),
|
||||||
});
|
);
|
||||||
}
|
|
||||||
return hasBackground(el.type)
|
|
||||||
? newElementWith(el, {
|
|
||||||
backgroundColor: value.currentItemBackgroundColor,
|
|
||||||
})
|
|
||||||
: el;
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -458,12 +444,7 @@ export const actionChangeBackgroundColor = register<
|
|||||||
(element) => element.backgroundColor,
|
(element) => element.backgroundColor,
|
||||||
true,
|
true,
|
||||||
(hasSelection) =>
|
(hasSelection) =>
|
||||||
!hasSelection
|
!hasSelection ? appState.currentItemBackgroundColor : null,
|
||||||
? appState.activeTool.type === "frame"
|
|
||||||
? // background default shouldn't apply to new frames
|
|
||||||
"transparent"
|
|
||||||
: appState.currentItemBackgroundColor
|
|
||||||
: null,
|
|
||||||
)}
|
)}
|
||||||
onChange={(color) =>
|
onChange={(color) =>
|
||||||
updateData({ currentItemBackgroundColor: color })
|
updateData({ currentItemBackgroundColor: color })
|
||||||
@@ -490,13 +471,11 @@ export const actionChangeFillStyle = register<ExcalidrawElement["fillStyle"]>({
|
|||||||
})`,
|
})`,
|
||||||
);
|
);
|
||||||
return {
|
return {
|
||||||
elements: changeProperty(elements, appState, (el) => {
|
elements: changeProperty(elements, appState, (el) =>
|
||||||
return hasBackground(el.type)
|
newElementWith(el, {
|
||||||
? newElementWith(el, {
|
fillStyle: value,
|
||||||
fillStyle: value,
|
}),
|
||||||
})
|
),
|
||||||
: el;
|
|
||||||
}),
|
|
||||||
appState: { ...appState, currentItemFillStyle: value },
|
appState: { ...appState, currentItemFillStyle: value },
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
||||||
};
|
};
|
||||||
@@ -569,13 +548,11 @@ export const actionChangeStrokeWidth = register<
|
|||||||
trackEvent: false,
|
trackEvent: false,
|
||||||
perform: (elements, appState, value) => {
|
perform: (elements, appState, value) => {
|
||||||
return {
|
return {
|
||||||
elements: changeProperty(elements, appState, (el) => {
|
elements: changeProperty(elements, appState, (el) =>
|
||||||
return hasStrokeWidth(el.type)
|
newElementWith(el, {
|
||||||
? newElementWith(el, {
|
strokeWidth: value,
|
||||||
strokeWidth: value,
|
}),
|
||||||
})
|
),
|
||||||
: el;
|
|
||||||
}),
|
|
||||||
appState: { ...appState, currentItemStrokeWidth: value },
|
appState: { ...appState, currentItemStrokeWidth: value },
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
||||||
};
|
};
|
||||||
@@ -627,14 +604,12 @@ export const actionChangeSloppiness = register<ExcalidrawElement["roughness"]>({
|
|||||||
trackEvent: false,
|
trackEvent: false,
|
||||||
perform: (elements, appState, value) => {
|
perform: (elements, appState, value) => {
|
||||||
return {
|
return {
|
||||||
elements: changeProperty(elements, appState, (el) => {
|
elements: changeProperty(elements, appState, (el) =>
|
||||||
return hasStrokeStyle(el.type)
|
newElementWith(el, {
|
||||||
? newElementWith(el, {
|
seed: randomInteger(),
|
||||||
seed: randomInteger(),
|
roughness: value,
|
||||||
roughness: value,
|
}),
|
||||||
})
|
),
|
||||||
: el;
|
|
||||||
}),
|
|
||||||
appState: { ...appState, currentItemRoughness: value },
|
appState: { ...appState, currentItemRoughness: value },
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
||||||
};
|
};
|
||||||
@@ -685,13 +660,11 @@ export const actionChangeStrokeStyle = register<
|
|||||||
trackEvent: false,
|
trackEvent: false,
|
||||||
perform: (elements, appState, value) => {
|
perform: (elements, appState, value) => {
|
||||||
return {
|
return {
|
||||||
elements: changeProperty(elements, appState, (el) => {
|
elements: changeProperty(elements, appState, (el) =>
|
||||||
return hasStrokeStyle(el.type)
|
newElementWith(el, {
|
||||||
? newElementWith(el, {
|
strokeStyle: value,
|
||||||
strokeStyle: value,
|
}),
|
||||||
})
|
),
|
||||||
: el;
|
|
||||||
}),
|
|
||||||
appState: { ...appState, currentItemStrokeStyle: value },
|
appState: { ...appState, currentItemStrokeStyle: value },
|
||||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
||||||
};
|
};
|
||||||
@@ -1503,7 +1476,7 @@ export const actionChangeRoundness = register<"sharp" | "round">({
|
|||||||
perform: (elements, appState, value) => {
|
perform: (elements, appState, value) => {
|
||||||
return {
|
return {
|
||||||
elements: changeProperty(elements, appState, (el) => {
|
elements: changeProperty(elements, appState, (el) => {
|
||||||
if (isElbowArrow(el) || !canChangeRoundness(el.type)) {
|
if (isElbowArrow(el)) {
|
||||||
return el;
|
return el;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1857,6 +1830,7 @@ export const actionChangeArrowType = register<keyof typeof ARROW_TYPE>({
|
|||||||
startElement,
|
startElement,
|
||||||
"start",
|
"start",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
|
appState.isBindingEnabled,
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
: null;
|
: null;
|
||||||
@@ -1870,6 +1844,7 @@ export const actionChangeArrowType = register<keyof typeof ARROW_TYPE>({
|
|||||||
endElement,
|
endElement,
|
||||||
"end",
|
"end",
|
||||||
elementsMap,
|
elementsMap,
|
||||||
|
appState.isBindingEnabled,
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
: null;
|
: null;
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
import { CaptureUpdateAction } from "@excalidraw/element";
|
||||||
|
|
||||||
|
import { register } from "./register";
|
||||||
|
|
||||||
|
export const actionToggleArrowBinding = register({
|
||||||
|
name: "arrowBinding",
|
||||||
|
label: "labels.arrowBinding",
|
||||||
|
viewMode: false,
|
||||||
|
trackEvent: {
|
||||||
|
category: "canvas",
|
||||||
|
predicate: (appState) => appState.bindingPreference === "disabled",
|
||||||
|
},
|
||||||
|
perform(elements, appState) {
|
||||||
|
const newPreference =
|
||||||
|
appState.bindingPreference === "enabled" ? "disabled" : "enabled";
|
||||||
|
return {
|
||||||
|
appState: {
|
||||||
|
...appState,
|
||||||
|
bindingPreference: newPreference,
|
||||||
|
isBindingEnabled: newPreference === "enabled",
|
||||||
|
},
|
||||||
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
checked: (appState) => appState.bindingPreference === "enabled",
|
||||||
|
});
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import { CaptureUpdateAction } from "@excalidraw/element";
|
||||||
|
|
||||||
|
import { register } from "./register";
|
||||||
|
|
||||||
|
export const actionToggleMidpointSnapping = register({
|
||||||
|
name: "midpointSnapping",
|
||||||
|
label: "labels.midpointSnapping",
|
||||||
|
viewMode: false,
|
||||||
|
trackEvent: {
|
||||||
|
category: "canvas",
|
||||||
|
predicate: (appState) => !appState.isMidpointSnappingEnabled,
|
||||||
|
},
|
||||||
|
perform(elements, appState) {
|
||||||
|
return {
|
||||||
|
appState: {
|
||||||
|
...appState,
|
||||||
|
isMidpointSnappingEnabled: !this.checked!(appState),
|
||||||
|
},
|
||||||
|
captureUpdate: CaptureUpdateAction.NEVER,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
checked: (appState) => appState.isMidpointSnappingEnabled,
|
||||||
|
});
|
||||||
@@ -79,6 +79,8 @@ export {
|
|||||||
export { actionToggleGridMode } from "./actionToggleGridMode";
|
export { actionToggleGridMode } from "./actionToggleGridMode";
|
||||||
export { actionToggleZenMode } from "./actionToggleZenMode";
|
export { actionToggleZenMode } from "./actionToggleZenMode";
|
||||||
export { actionToggleObjectsSnapMode } from "./actionToggleObjectsSnapMode";
|
export { actionToggleObjectsSnapMode } from "./actionToggleObjectsSnapMode";
|
||||||
|
export { actionToggleArrowBinding } from "./actionToggleArrowBinding";
|
||||||
|
export { actionToggleMidpointSnapping } from "./actionToggleMidpointSnapping";
|
||||||
|
|
||||||
export { actionToggleStats } from "./actionToggleStats";
|
export { actionToggleStats } from "./actionToggleStats";
|
||||||
export { actionUnbindText, actionBindText } from "./actionBoundText";
|
export { actionUnbindText, actionBindText } from "./actionBoundText";
|
||||||
|
|||||||
@@ -59,6 +59,8 @@ export type ActionName =
|
|||||||
| "gridMode"
|
| "gridMode"
|
||||||
| "zenMode"
|
| "zenMode"
|
||||||
| "objectsSnapMode"
|
| "objectsSnapMode"
|
||||||
|
| "arrowBinding"
|
||||||
|
| "midpointSnapping"
|
||||||
| "stats"
|
| "stats"
|
||||||
| "changeStrokeColor"
|
| "changeStrokeColor"
|
||||||
| "changeBackgroundColor"
|
| "changeBackgroundColor"
|
||||||
|
|||||||
@@ -27,7 +27,6 @@ export const getDefaultAppState = (): Omit<
|
|||||||
showWelcomeScreen: false,
|
showWelcomeScreen: false,
|
||||||
theme: THEME.LIGHT,
|
theme: THEME.LIGHT,
|
||||||
collaborators: new Map(),
|
collaborators: new Map(),
|
||||||
currentChartType: "bar",
|
|
||||||
currentItemBackgroundColor: DEFAULT_ELEMENT_PROPS.backgroundColor,
|
currentItemBackgroundColor: DEFAULT_ELEMENT_PROPS.backgroundColor,
|
||||||
currentItemEndArrowhead: "arrow",
|
currentItemEndArrowhead: "arrow",
|
||||||
currentItemFillStyle: DEFAULT_ELEMENT_PROPS.fillStyle,
|
currentItemFillStyle: DEFAULT_ELEMENT_PROPS.fillStyle,
|
||||||
@@ -71,6 +70,8 @@ export const getDefaultAppState = (): Omit<
|
|||||||
gridStep: DEFAULT_GRID_STEP,
|
gridStep: DEFAULT_GRID_STEP,
|
||||||
gridModeEnabled: false,
|
gridModeEnabled: false,
|
||||||
isBindingEnabled: true,
|
isBindingEnabled: true,
|
||||||
|
bindingPreference: "enabled",
|
||||||
|
isMidpointSnappingEnabled: true,
|
||||||
defaultSidebarDockedPreference: false,
|
defaultSidebarDockedPreference: false,
|
||||||
isLoading: false,
|
isLoading: false,
|
||||||
isResizing: false,
|
isResizing: false,
|
||||||
@@ -83,7 +84,6 @@ export const getDefaultAppState = (): Omit<
|
|||||||
openPopup: null,
|
openPopup: null,
|
||||||
openSidebar: null,
|
openSidebar: null,
|
||||||
openDialog: null,
|
openDialog: null,
|
||||||
pasteDialog: { shown: false, data: null },
|
|
||||||
previousSelectedElementIds: {},
|
previousSelectedElementIds: {},
|
||||||
resizingElement: null,
|
resizingElement: null,
|
||||||
scrolledOutside: false,
|
scrolledOutside: false,
|
||||||
@@ -150,7 +150,6 @@ const APP_STATE_STORAGE_CONF = (<
|
|||||||
showWelcomeScreen: { browser: true, export: false, server: false },
|
showWelcomeScreen: { browser: true, export: false, server: false },
|
||||||
theme: { browser: true, export: false, server: false },
|
theme: { browser: true, export: false, server: false },
|
||||||
collaborators: { browser: false, export: false, server: false },
|
collaborators: { browser: false, export: false, server: false },
|
||||||
currentChartType: { browser: true, export: false, server: false },
|
|
||||||
currentItemBackgroundColor: { browser: true, export: false, server: false },
|
currentItemBackgroundColor: { browser: true, export: false, server: false },
|
||||||
currentItemEndArrowhead: { browser: true, export: false, server: false },
|
currentItemEndArrowhead: { browser: true, export: false, server: false },
|
||||||
currentItemFillStyle: { browser: true, export: false, server: false },
|
currentItemFillStyle: { browser: true, export: false, server: false },
|
||||||
@@ -193,7 +192,9 @@ const APP_STATE_STORAGE_CONF = (<
|
|||||||
gridStep: { browser: true, export: true, server: true },
|
gridStep: { browser: true, export: true, server: true },
|
||||||
gridModeEnabled: { browser: true, export: true, server: true },
|
gridModeEnabled: { browser: true, export: true, server: true },
|
||||||
height: { browser: false, export: false, server: false },
|
height: { browser: false, export: false, server: false },
|
||||||
isBindingEnabled: { browser: false, export: false, server: false },
|
isBindingEnabled: { browser: true, export: false, server: false },
|
||||||
|
bindingPreference: { browser: true, export: false, server: false },
|
||||||
|
isMidpointSnappingEnabled: { browser: true, export: false, server: false },
|
||||||
defaultSidebarDockedPreference: {
|
defaultSidebarDockedPreference: {
|
||||||
browser: true,
|
browser: true,
|
||||||
export: false,
|
export: false,
|
||||||
@@ -212,7 +213,6 @@ const APP_STATE_STORAGE_CONF = (<
|
|||||||
openPopup: { browser: false, export: false, server: false },
|
openPopup: { browser: false, export: false, server: false },
|
||||||
openSidebar: { browser: true, export: false, server: false },
|
openSidebar: { browser: true, export: false, server: false },
|
||||||
openDialog: { browser: false, export: false, server: false },
|
openDialog: { browser: false, export: false, server: false },
|
||||||
pasteDialog: { browser: false, export: false, server: false },
|
|
||||||
previousSelectedElementIds: { browser: true, export: false, server: false },
|
previousSelectedElementIds: { browser: true, export: false, server: false },
|
||||||
resizingElement: { browser: false, export: false, server: false },
|
resizingElement: { browser: false, export: false, server: false },
|
||||||
scrolledOutside: { browser: true, export: false, server: false },
|
scrolledOutside: { browser: true, export: false, server: false },
|
||||||
|
|||||||
+1063
-16
File diff suppressed because it is too large
Load Diff
@@ -1,481 +0,0 @@
|
|||||||
import { pointFrom } from "@excalidraw/math";
|
|
||||||
|
|
||||||
import {
|
|
||||||
COLOR_PALETTE,
|
|
||||||
DEFAULT_CHART_COLOR_INDEX,
|
|
||||||
getAllColorsSpecificShade,
|
|
||||||
DEFAULT_FONT_FAMILY,
|
|
||||||
DEFAULT_FONT_SIZE,
|
|
||||||
VERTICAL_ALIGN,
|
|
||||||
randomId,
|
|
||||||
isDevEnv,
|
|
||||||
FONT_SIZES,
|
|
||||||
} from "@excalidraw/common";
|
|
||||||
|
|
||||||
import {
|
|
||||||
newTextElement,
|
|
||||||
newLinearElement,
|
|
||||||
newElement,
|
|
||||||
} from "@excalidraw/element";
|
|
||||||
|
|
||||||
import type { Radians } from "@excalidraw/math";
|
|
||||||
|
|
||||||
import type { NonDeletedExcalidrawElement } from "@excalidraw/element/types";
|
|
||||||
|
|
||||||
export type ChartElements = readonly NonDeletedExcalidrawElement[];
|
|
||||||
|
|
||||||
const BAR_WIDTH = 32;
|
|
||||||
const BAR_GAP = 12;
|
|
||||||
const BAR_HEIGHT = 256;
|
|
||||||
const GRID_OPACITY = 50;
|
|
||||||
|
|
||||||
export interface Spreadsheet {
|
|
||||||
title: string | null;
|
|
||||||
labels: string[] | null;
|
|
||||||
values: number[];
|
|
||||||
}
|
|
||||||
|
|
||||||
export const NOT_SPREADSHEET = "NOT_SPREADSHEET";
|
|
||||||
export const VALID_SPREADSHEET = "VALID_SPREADSHEET";
|
|
||||||
|
|
||||||
type ParseSpreadsheetResult =
|
|
||||||
| { type: typeof NOT_SPREADSHEET; reason: string }
|
|
||||||
| { type: typeof VALID_SPREADSHEET; spreadsheet: Spreadsheet };
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @private exported for testing
|
|
||||||
*/
|
|
||||||
export const tryParseNumber = (s: string): number | null => {
|
|
||||||
const match = /^([-+]?)[$€£¥₩]?([-+]?)([\d.,]+)[%]?$/.exec(s);
|
|
||||||
if (!match) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return parseFloat(`${(match[1] || match[2]) + match[3]}`.replace(/,/g, ""));
|
|
||||||
};
|
|
||||||
|
|
||||||
const isNumericColumn = (lines: string[][], columnIndex: number) =>
|
|
||||||
lines.slice(1).every((line) => tryParseNumber(line[columnIndex]) !== null);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @private exported for testing
|
|
||||||
*/
|
|
||||||
export const tryParseCells = (cells: string[][]): ParseSpreadsheetResult => {
|
|
||||||
const numCols = cells[0].length;
|
|
||||||
|
|
||||||
if (numCols > 2) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "More than 2 columns" };
|
|
||||||
}
|
|
||||||
|
|
||||||
if (numCols === 1) {
|
|
||||||
if (!isNumericColumn(cells, 0)) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "Value is not numeric" };
|
|
||||||
}
|
|
||||||
|
|
||||||
const hasHeader = tryParseNumber(cells[0][0]) === null;
|
|
||||||
const values = (hasHeader ? cells.slice(1) : cells).map((line) =>
|
|
||||||
tryParseNumber(line[0]),
|
|
||||||
);
|
|
||||||
|
|
||||||
if (values.length < 2) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "Less than two rows" };
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
type: VALID_SPREADSHEET,
|
|
||||||
spreadsheet: {
|
|
||||||
title: hasHeader ? cells[0][0] : null,
|
|
||||||
labels: null,
|
|
||||||
values: values as number[],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const labelColumnNumeric = isNumericColumn(cells, 0);
|
|
||||||
const valueColumnNumeric = isNumericColumn(cells, 1);
|
|
||||||
|
|
||||||
if (!labelColumnNumeric && !valueColumnNumeric) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "Value is not numeric" };
|
|
||||||
}
|
|
||||||
|
|
||||||
const [labelColumnIndex, valueColumnIndex] = valueColumnNumeric
|
|
||||||
? [0, 1]
|
|
||||||
: [1, 0];
|
|
||||||
const hasHeader = tryParseNumber(cells[0][valueColumnIndex]) === null;
|
|
||||||
const rows = hasHeader ? cells.slice(1) : cells;
|
|
||||||
|
|
||||||
if (rows.length < 2) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "Less than 2 rows" };
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
type: VALID_SPREADSHEET,
|
|
||||||
spreadsheet: {
|
|
||||||
title: hasHeader ? cells[0][valueColumnIndex] : null,
|
|
||||||
labels: rows.map((row) => row[labelColumnIndex]),
|
|
||||||
values: rows.map((row) => tryParseNumber(row[valueColumnIndex])!),
|
|
||||||
},
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const transposeCells = (cells: string[][]) => {
|
|
||||||
const nextCells: string[][] = [];
|
|
||||||
for (let col = 0; col < cells[0].length; col++) {
|
|
||||||
const nextCellRow: string[] = [];
|
|
||||||
for (let row = 0; row < cells.length; row++) {
|
|
||||||
nextCellRow.push(cells[row][col]);
|
|
||||||
}
|
|
||||||
nextCells.push(nextCellRow);
|
|
||||||
}
|
|
||||||
return nextCells;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const tryParseSpreadsheet = (text: string): ParseSpreadsheetResult => {
|
|
||||||
// Copy/paste from excel, spreadsheets, tsv, csv.
|
|
||||||
// For now we only accept 2 columns with an optional header
|
|
||||||
|
|
||||||
// Check for tab separated values
|
|
||||||
let lines = text
|
|
||||||
.trim()
|
|
||||||
.split("\n")
|
|
||||||
.map((line) => line.trim().split("\t"));
|
|
||||||
|
|
||||||
// Check for comma separated files
|
|
||||||
if (lines.length && lines[0].length !== 2) {
|
|
||||||
lines = text
|
|
||||||
.trim()
|
|
||||||
.split("\n")
|
|
||||||
.map((line) => line.trim().split(","));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (lines.length === 0) {
|
|
||||||
return { type: NOT_SPREADSHEET, reason: "No values" };
|
|
||||||
}
|
|
||||||
|
|
||||||
const numColsFirstLine = lines[0].length;
|
|
||||||
const isSpreadsheet = lines.every((line) => line.length === numColsFirstLine);
|
|
||||||
|
|
||||||
if (!isSpreadsheet) {
|
|
||||||
return {
|
|
||||||
type: NOT_SPREADSHEET,
|
|
||||||
reason: "All rows don't have same number of columns",
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = tryParseCells(lines);
|
|
||||||
if (result.type !== VALID_SPREADSHEET) {
|
|
||||||
const transposedResults = tryParseCells(transposeCells(lines));
|
|
||||||
if (transposedResults.type === VALID_SPREADSHEET) {
|
|
||||||
return transposedResults;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
|
|
||||||
const bgColors = getAllColorsSpecificShade(DEFAULT_CHART_COLOR_INDEX);
|
|
||||||
|
|
||||||
// Put all the common properties here so when the whole chart is selected
|
|
||||||
// the properties dialog shows the correct selected values
|
|
||||||
const commonProps = {
|
|
||||||
fillStyle: "hachure",
|
|
||||||
fontFamily: DEFAULT_FONT_FAMILY,
|
|
||||||
fontSize: DEFAULT_FONT_SIZE,
|
|
||||||
opacity: 100,
|
|
||||||
roughness: 1,
|
|
||||||
strokeColor: COLOR_PALETTE.black,
|
|
||||||
roundness: null,
|
|
||||||
strokeStyle: "solid",
|
|
||||||
strokeWidth: 1,
|
|
||||||
verticalAlign: VERTICAL_ALIGN.MIDDLE,
|
|
||||||
locked: false,
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
const getChartDimensions = (spreadsheet: Spreadsheet) => {
|
|
||||||
const chartWidth =
|
|
||||||
(BAR_WIDTH + BAR_GAP) * spreadsheet.values.length + BAR_GAP;
|
|
||||||
const chartHeight = BAR_HEIGHT + BAR_GAP * 2;
|
|
||||||
return { chartWidth, chartHeight };
|
|
||||||
};
|
|
||||||
|
|
||||||
const chartXLabels = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
groupId: string,
|
|
||||||
backgroundColor: string,
|
|
||||||
): ChartElements => {
|
|
||||||
return (
|
|
||||||
spreadsheet.labels?.map((label, index) => {
|
|
||||||
return newTextElement({
|
|
||||||
groupIds: [groupId],
|
|
||||||
backgroundColor,
|
|
||||||
...commonProps,
|
|
||||||
text: label.length > 8 ? `${label.slice(0, 5)}...` : label,
|
|
||||||
x: x + index * (BAR_WIDTH + BAR_GAP) + BAR_GAP * 2,
|
|
||||||
y: y + BAR_GAP / 2,
|
|
||||||
width: BAR_WIDTH,
|
|
||||||
angle: 5.87 as Radians,
|
|
||||||
fontSize: FONT_SIZES.sm,
|
|
||||||
textAlign: "center",
|
|
||||||
verticalAlign: "top",
|
|
||||||
});
|
|
||||||
}) || []
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
const chartYLabels = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
groupId: string,
|
|
||||||
backgroundColor: string,
|
|
||||||
): ChartElements => {
|
|
||||||
const minYLabel = newTextElement({
|
|
||||||
groupIds: [groupId],
|
|
||||||
backgroundColor,
|
|
||||||
...commonProps,
|
|
||||||
x: x - BAR_GAP,
|
|
||||||
y: y - BAR_GAP,
|
|
||||||
text: "0",
|
|
||||||
textAlign: "right",
|
|
||||||
});
|
|
||||||
|
|
||||||
const maxYLabel = newTextElement({
|
|
||||||
groupIds: [groupId],
|
|
||||||
backgroundColor,
|
|
||||||
...commonProps,
|
|
||||||
x: x - BAR_GAP,
|
|
||||||
y: y - BAR_HEIGHT - minYLabel.height / 2,
|
|
||||||
text: Math.max(...spreadsheet.values).toLocaleString(),
|
|
||||||
textAlign: "right",
|
|
||||||
});
|
|
||||||
|
|
||||||
return [minYLabel, maxYLabel];
|
|
||||||
};
|
|
||||||
|
|
||||||
const chartLines = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
groupId: string,
|
|
||||||
backgroundColor: string,
|
|
||||||
): ChartElements => {
|
|
||||||
const { chartWidth, chartHeight } = getChartDimensions(spreadsheet);
|
|
||||||
const xLine = newLinearElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "line",
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
width: chartWidth,
|
|
||||||
points: [pointFrom(0, 0), pointFrom(chartWidth, 0)],
|
|
||||||
});
|
|
||||||
|
|
||||||
const yLine = newLinearElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "line",
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
height: chartHeight,
|
|
||||||
points: [pointFrom(0, 0), pointFrom(0, -chartHeight)],
|
|
||||||
});
|
|
||||||
|
|
||||||
const maxLine = newLinearElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "line",
|
|
||||||
x,
|
|
||||||
y: y - BAR_HEIGHT - BAR_GAP,
|
|
||||||
strokeStyle: "dotted",
|
|
||||||
width: chartWidth,
|
|
||||||
opacity: GRID_OPACITY,
|
|
||||||
points: [pointFrom(0, 0), pointFrom(chartWidth, 0)],
|
|
||||||
});
|
|
||||||
|
|
||||||
return [xLine, yLine, maxLine];
|
|
||||||
};
|
|
||||||
|
|
||||||
// For the maths behind it https://excalidraw.com/#json=6320864370884608,O_5xfD-Agh32tytHpRJx1g
|
|
||||||
const chartBaseElements = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
groupId: string,
|
|
||||||
backgroundColor: string,
|
|
||||||
debug?: boolean,
|
|
||||||
): ChartElements => {
|
|
||||||
const { chartWidth, chartHeight } = getChartDimensions(spreadsheet);
|
|
||||||
|
|
||||||
const title = spreadsheet.title
|
|
||||||
? newTextElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
text: spreadsheet.title,
|
|
||||||
x: x + chartWidth / 2,
|
|
||||||
y: y - BAR_HEIGHT - BAR_GAP * 2 - DEFAULT_FONT_SIZE,
|
|
||||||
roundness: null,
|
|
||||||
textAlign: "center",
|
|
||||||
})
|
|
||||||
: null;
|
|
||||||
|
|
||||||
const debugRect = debug
|
|
||||||
? newElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "rectangle",
|
|
||||||
x,
|
|
||||||
y: y - chartHeight,
|
|
||||||
width: chartWidth,
|
|
||||||
height: chartHeight,
|
|
||||||
strokeColor: COLOR_PALETTE.black,
|
|
||||||
fillStyle: "solid",
|
|
||||||
opacity: 6,
|
|
||||||
})
|
|
||||||
: null;
|
|
||||||
|
|
||||||
return [
|
|
||||||
...(debugRect ? [debugRect] : []),
|
|
||||||
...(title ? [title] : []),
|
|
||||||
...chartXLabels(spreadsheet, x, y, groupId, backgroundColor),
|
|
||||||
...chartYLabels(spreadsheet, x, y, groupId, backgroundColor),
|
|
||||||
...chartLines(spreadsheet, x, y, groupId, backgroundColor),
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
const chartTypeBar = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
): ChartElements => {
|
|
||||||
const max = Math.max(...spreadsheet.values);
|
|
||||||
const groupId = randomId();
|
|
||||||
const backgroundColor = bgColors[Math.floor(Math.random() * bgColors.length)];
|
|
||||||
|
|
||||||
const bars = spreadsheet.values.map((value, index) => {
|
|
||||||
const barHeight = (value / max) * BAR_HEIGHT;
|
|
||||||
return newElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "rectangle",
|
|
||||||
x: x + index * (BAR_WIDTH + BAR_GAP) + BAR_GAP,
|
|
||||||
y: y - barHeight - BAR_GAP,
|
|
||||||
width: BAR_WIDTH,
|
|
||||||
height: barHeight,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return [
|
|
||||||
...bars,
|
|
||||||
...chartBaseElements(
|
|
||||||
spreadsheet,
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
groupId,
|
|
||||||
backgroundColor,
|
|
||||||
isDevEnv(),
|
|
||||||
),
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
const chartTypeLine = (
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
): ChartElements => {
|
|
||||||
const max = Math.max(...spreadsheet.values);
|
|
||||||
const groupId = randomId();
|
|
||||||
const backgroundColor = bgColors[Math.floor(Math.random() * bgColors.length)];
|
|
||||||
|
|
||||||
let index = 0;
|
|
||||||
const points = [];
|
|
||||||
for (const value of spreadsheet.values) {
|
|
||||||
const cx = index * (BAR_WIDTH + BAR_GAP);
|
|
||||||
const cy = -(value / max) * BAR_HEIGHT;
|
|
||||||
points.push([cx, cy]);
|
|
||||||
index++;
|
|
||||||
}
|
|
||||||
|
|
||||||
const maxX = Math.max(...points.map((element) => element[0]));
|
|
||||||
const maxY = Math.max(...points.map((element) => element[1]));
|
|
||||||
const minX = Math.min(...points.map((element) => element[0]));
|
|
||||||
const minY = Math.min(...points.map((element) => element[1]));
|
|
||||||
|
|
||||||
const line = newLinearElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "line",
|
|
||||||
x: x + BAR_GAP + BAR_WIDTH / 2,
|
|
||||||
y: y - BAR_GAP,
|
|
||||||
height: maxY - minY,
|
|
||||||
width: maxX - minX,
|
|
||||||
strokeWidth: 2,
|
|
||||||
points: points as any,
|
|
||||||
});
|
|
||||||
|
|
||||||
const dots = spreadsheet.values.map((value, index) => {
|
|
||||||
const cx = index * (BAR_WIDTH + BAR_GAP) + BAR_GAP / 2;
|
|
||||||
const cy = -(value / max) * BAR_HEIGHT + BAR_GAP / 2;
|
|
||||||
return newElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
fillStyle: "solid",
|
|
||||||
strokeWidth: 2,
|
|
||||||
type: "ellipse",
|
|
||||||
x: x + cx + BAR_WIDTH / 2,
|
|
||||||
y: y + cy - BAR_GAP * 2,
|
|
||||||
width: BAR_GAP,
|
|
||||||
height: BAR_GAP,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
const lines = spreadsheet.values.map((value, index) => {
|
|
||||||
const cx = index * (BAR_WIDTH + BAR_GAP) + BAR_GAP / 2;
|
|
||||||
const cy = (value / max) * BAR_HEIGHT + BAR_GAP / 2 + BAR_GAP;
|
|
||||||
return newLinearElement({
|
|
||||||
backgroundColor,
|
|
||||||
groupIds: [groupId],
|
|
||||||
...commonProps,
|
|
||||||
type: "line",
|
|
||||||
x: x + cx + BAR_WIDTH / 2 + BAR_GAP / 2,
|
|
||||||
y: y - cy,
|
|
||||||
height: cy,
|
|
||||||
strokeStyle: "dotted",
|
|
||||||
opacity: GRID_OPACITY,
|
|
||||||
points: [pointFrom(0, 0), pointFrom(0, cy)],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return [
|
|
||||||
...chartBaseElements(
|
|
||||||
spreadsheet,
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
groupId,
|
|
||||||
backgroundColor,
|
|
||||||
isDevEnv(),
|
|
||||||
),
|
|
||||||
line,
|
|
||||||
...lines,
|
|
||||||
...dots,
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
export const renderSpreadsheet = (
|
|
||||||
chartType: string,
|
|
||||||
spreadsheet: Spreadsheet,
|
|
||||||
x: number,
|
|
||||||
y: number,
|
|
||||||
): ChartElements => {
|
|
||||||
if (chartType === "line") {
|
|
||||||
return chartTypeLine(spreadsheet, x, y);
|
|
||||||
}
|
|
||||||
return chartTypeBar(spreadsheet, x, y);
|
|
||||||
};
|
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
import { isDevEnv } from "@excalidraw/common";
|
||||||
|
|
||||||
|
import { newElement } from "@excalidraw/element";
|
||||||
|
|
||||||
|
import { commonProps } from "./charts.constants";
|
||||||
|
import {
|
||||||
|
chartBaseElements,
|
||||||
|
chartXLabels,
|
||||||
|
createSeriesLegend,
|
||||||
|
getBackgroundColor,
|
||||||
|
getCartesianChartLayout,
|
||||||
|
getChartDimensions,
|
||||||
|
getColorOffset,
|
||||||
|
getRotatedTextElementBottom,
|
||||||
|
getSeriesColors,
|
||||||
|
} from "./charts.helpers";
|
||||||
|
|
||||||
|
import type { ChartElements, Spreadsheet } from "./charts.types";
|
||||||
|
|
||||||
|
export const renderBarChart = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
colorSeed?: number,
|
||||||
|
): ChartElements => {
|
||||||
|
const series = spreadsheet.series;
|
||||||
|
const layout = getCartesianChartLayout("bar", series.length);
|
||||||
|
const max = Math.max(
|
||||||
|
1,
|
||||||
|
...series.flatMap((seriesData) =>
|
||||||
|
seriesData.values.map((value) => Math.max(0, value)),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const colorOffset = getColorOffset(colorSeed);
|
||||||
|
const backgroundColor = getBackgroundColor(colorOffset);
|
||||||
|
const seriesColors = getSeriesColors(series.length, colorOffset);
|
||||||
|
const interBarGap =
|
||||||
|
series.length > 1
|
||||||
|
? Math.max(1, Math.floor(layout.gap / (series.length + 1)))
|
||||||
|
: 0;
|
||||||
|
const barWidth =
|
||||||
|
series.length > 1
|
||||||
|
? Math.max(
|
||||||
|
2,
|
||||||
|
(layout.slotWidth - interBarGap * (series.length - 1)) /
|
||||||
|
series.length,
|
||||||
|
)
|
||||||
|
: layout.slotWidth;
|
||||||
|
const clusterWidth =
|
||||||
|
series.length * barWidth + interBarGap * (series.length - 1);
|
||||||
|
const clusterOffset = (layout.slotWidth - clusterWidth) / 2;
|
||||||
|
|
||||||
|
const bars = series[0].values.flatMap((_, categoryIndex) =>
|
||||||
|
series.map((seriesData, seriesIndex) => {
|
||||||
|
const value = Math.max(0, seriesData.values[categoryIndex] ?? 0);
|
||||||
|
const barHeight = (value / max) * layout.chartHeight;
|
||||||
|
const barColor =
|
||||||
|
series.length > 1 ? seriesColors[seriesIndex] : backgroundColor;
|
||||||
|
return newElement({
|
||||||
|
backgroundColor: barColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "rectangle",
|
||||||
|
fillStyle: series.length > 1 ? "solid" : commonProps.fillStyle,
|
||||||
|
strokeColor: series.length > 1 ? barColor : commonProps.strokeColor,
|
||||||
|
x:
|
||||||
|
x +
|
||||||
|
categoryIndex * (layout.slotWidth + layout.gap) +
|
||||||
|
layout.gap +
|
||||||
|
clusterOffset +
|
||||||
|
seriesIndex * (barWidth + interBarGap),
|
||||||
|
y: y - barHeight - layout.gap,
|
||||||
|
width: barWidth,
|
||||||
|
height: barHeight,
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const baseElements = chartBaseElements(
|
||||||
|
spreadsheet,
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
backgroundColor,
|
||||||
|
layout,
|
||||||
|
max,
|
||||||
|
isDevEnv(),
|
||||||
|
);
|
||||||
|
const xLabels = chartXLabels(spreadsheet, x, y, backgroundColor, layout);
|
||||||
|
const xLabelsBottomY = Math.max(
|
||||||
|
y + layout.gap / 2,
|
||||||
|
...xLabels.map((label) => getRotatedTextElementBottom(label)),
|
||||||
|
);
|
||||||
|
const { chartWidth } = getChartDimensions(spreadsheet, layout);
|
||||||
|
const seriesLegend = createSeriesLegend(
|
||||||
|
series,
|
||||||
|
seriesColors,
|
||||||
|
x + chartWidth / 2,
|
||||||
|
xLabelsBottomY,
|
||||||
|
y + layout.gap * 5,
|
||||||
|
backgroundColor,
|
||||||
|
);
|
||||||
|
|
||||||
|
return [...baseElements, ...bars, ...seriesLegend];
|
||||||
|
};
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
import {
|
||||||
|
COLOR_PALETTE,
|
||||||
|
DEFAULT_FONT_FAMILY,
|
||||||
|
DEFAULT_FONT_SIZE,
|
||||||
|
VERTICAL_ALIGN,
|
||||||
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
|
import type { Radians } from "@excalidraw/math";
|
||||||
|
|
||||||
|
export const CARTESIAN_BASE_SLOT_WIDTH = 44;
|
||||||
|
export const CARTESIAN_BAR_SLOT_EXTRA_PER_SERIES = 22;
|
||||||
|
export const CARTESIAN_BAR_SLOT_EXTRA_MAX = 66;
|
||||||
|
export const CARTESIAN_LINE_SLOT_WIDTH = 48;
|
||||||
|
export const CARTESIAN_GAP = 14;
|
||||||
|
export const CARTESIAN_BAR_HEIGHT = 304;
|
||||||
|
export const CARTESIAN_LINE_HEIGHT = 320;
|
||||||
|
export const CARTESIAN_LABEL_ROTATION = 5.87 as Radians;
|
||||||
|
export const CARTESIAN_LABEL_MIN_WIDTH = 28;
|
||||||
|
export const CARTESIAN_LABEL_SLOT_PADDING = 4;
|
||||||
|
export const CARTESIAN_LABEL_AXIS_CLEARANCE = 2;
|
||||||
|
export const CARTESIAN_LABEL_MAX_WIDTH_BUFFER = 10;
|
||||||
|
export const CARTESIAN_LABEL_ROTATED_WIDTH_BUFFER = 10;
|
||||||
|
export const CARTESIAN_LABEL_OVERFLOW_PREFERENCE_BUFFER = 8;
|
||||||
|
|
||||||
|
export const BAR_GAP = 12;
|
||||||
|
export const BAR_HEIGHT = 256;
|
||||||
|
export const GRID_OPACITY = 10;
|
||||||
|
|
||||||
|
export const RADAR_GRID_LEVELS = 4;
|
||||||
|
export const RADAR_LABEL_OFFSET = BAR_GAP * 2;
|
||||||
|
export const RADAR_PADDING = BAR_GAP * 2;
|
||||||
|
export const RADAR_SINGLE_SERIES_LOG_SCALE_THRESHOLD = 100;
|
||||||
|
export const RADAR_AXIS_LABEL_MAX_WIDTH = 140;
|
||||||
|
export const RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD = 0.35;
|
||||||
|
export const RADAR_AXIS_LABEL_CLEARANCE = BAR_GAP / 2;
|
||||||
|
export const RADAR_LEGEND_SWATCH_SIZE = 20;
|
||||||
|
export const RADAR_LEGEND_ITEM_GAP = BAR_GAP * 2;
|
||||||
|
export const RADAR_LEGEND_TEXT_GAP = BAR_GAP;
|
||||||
|
|
||||||
|
// Put all common chart element properties here so properties dialog
|
||||||
|
// shows stable values when selecting chart groups.
|
||||||
|
export const commonProps = {
|
||||||
|
fillStyle: "hachure",
|
||||||
|
fontFamily: DEFAULT_FONT_FAMILY,
|
||||||
|
fontSize: DEFAULT_FONT_SIZE,
|
||||||
|
opacity: 100,
|
||||||
|
roughness: 1,
|
||||||
|
strokeColor: COLOR_PALETTE.black,
|
||||||
|
roundness: null,
|
||||||
|
strokeStyle: "solid",
|
||||||
|
strokeWidth: 1,
|
||||||
|
verticalAlign: VERTICAL_ALIGN.MIDDLE,
|
||||||
|
locked: false,
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
export type CartesianChartType = "bar" | "line";
|
||||||
|
|
||||||
|
export type CartesianChartLayout = {
|
||||||
|
slotWidth: number;
|
||||||
|
gap: number;
|
||||||
|
chartHeight: number;
|
||||||
|
xLabelMaxWidth: number;
|
||||||
|
};
|
||||||
@@ -0,0 +1,865 @@
|
|||||||
|
import { pointFrom } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import {
|
||||||
|
COLOR_PALETTE,
|
||||||
|
DEFAULT_CHART_COLOR_INDEX,
|
||||||
|
FONT_FAMILY,
|
||||||
|
FONT_SIZES,
|
||||||
|
ROUNDNESS,
|
||||||
|
DEFAULT_FONT_SIZE,
|
||||||
|
getAllColorsSpecificShade,
|
||||||
|
getFontString,
|
||||||
|
getLineHeight,
|
||||||
|
ROUGHNESS,
|
||||||
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
|
import {
|
||||||
|
getApproxMinLineWidth,
|
||||||
|
measureText,
|
||||||
|
newElement,
|
||||||
|
newLinearElement,
|
||||||
|
newTextElement,
|
||||||
|
wrapText,
|
||||||
|
} from "@excalidraw/element";
|
||||||
|
|
||||||
|
import type {
|
||||||
|
ChartType,
|
||||||
|
ExcalidrawTextElement,
|
||||||
|
} from "@excalidraw/element/types";
|
||||||
|
import type { NonDeletedExcalidrawElement } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
import {
|
||||||
|
BAR_GAP,
|
||||||
|
CARTESIAN_BAR_HEIGHT,
|
||||||
|
CARTESIAN_BASE_SLOT_WIDTH,
|
||||||
|
CARTESIAN_BAR_SLOT_EXTRA_MAX,
|
||||||
|
CARTESIAN_BAR_SLOT_EXTRA_PER_SERIES,
|
||||||
|
CARTESIAN_GAP,
|
||||||
|
CARTESIAN_LABEL_AXIS_CLEARANCE,
|
||||||
|
CARTESIAN_LABEL_MAX_WIDTH_BUFFER,
|
||||||
|
CARTESIAN_LABEL_MIN_WIDTH,
|
||||||
|
CARTESIAN_LABEL_OVERFLOW_PREFERENCE_BUFFER,
|
||||||
|
CARTESIAN_LABEL_ROTATED_WIDTH_BUFFER,
|
||||||
|
CARTESIAN_LABEL_ROTATION,
|
||||||
|
CARTESIAN_LABEL_SLOT_PADDING,
|
||||||
|
CARTESIAN_LINE_HEIGHT,
|
||||||
|
CARTESIAN_LINE_SLOT_WIDTH,
|
||||||
|
GRID_OPACITY,
|
||||||
|
RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD,
|
||||||
|
RADAR_AXIS_LABEL_CLEARANCE,
|
||||||
|
RADAR_AXIS_LABEL_MAX_WIDTH,
|
||||||
|
RADAR_LABEL_OFFSET,
|
||||||
|
RADAR_LEGEND_ITEM_GAP,
|
||||||
|
RADAR_LEGEND_SWATCH_SIZE,
|
||||||
|
RADAR_LEGEND_TEXT_GAP,
|
||||||
|
RADAR_PADDING,
|
||||||
|
RADAR_SINGLE_SERIES_LOG_SCALE_THRESHOLD,
|
||||||
|
BAR_HEIGHT,
|
||||||
|
commonProps,
|
||||||
|
type CartesianChartLayout,
|
||||||
|
type CartesianChartType,
|
||||||
|
} from "./charts.constants";
|
||||||
|
|
||||||
|
import type {
|
||||||
|
ChartElements,
|
||||||
|
Spreadsheet,
|
||||||
|
SpreadsheetSeries,
|
||||||
|
} from "./charts.types";
|
||||||
|
|
||||||
|
const bgColors = getAllColorsSpecificShade(DEFAULT_CHART_COLOR_INDEX);
|
||||||
|
|
||||||
|
const getSpreadsheetDimensionCount = (spreadsheet: Spreadsheet) =>
|
||||||
|
spreadsheet.labels?.length ?? spreadsheet.series[0]?.values.length ?? 0;
|
||||||
|
|
||||||
|
export const isSpreadsheetValidForChartType = (
|
||||||
|
spreadsheet: Spreadsheet | null,
|
||||||
|
chartType: ChartType,
|
||||||
|
) => {
|
||||||
|
if (!spreadsheet) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const dimensionCount = getSpreadsheetDimensionCount(spreadsheet);
|
||||||
|
if (dimensionCount < 2) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (chartType === "radar") {
|
||||||
|
return dimensionCount >= 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
};
|
||||||
|
|
||||||
|
const getSeriesAwareSlotWidth = (
|
||||||
|
baseSlotWidth: number,
|
||||||
|
seriesCount: number,
|
||||||
|
) => {
|
||||||
|
const extraSlotWidth =
|
||||||
|
seriesCount <= 1
|
||||||
|
? 0
|
||||||
|
: Math.min(
|
||||||
|
CARTESIAN_BAR_SLOT_EXTRA_MAX,
|
||||||
|
(seriesCount - 1) * CARTESIAN_BAR_SLOT_EXTRA_PER_SERIES,
|
||||||
|
);
|
||||||
|
return baseSlotWidth + extraSlotWidth;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getCartesianChartLayout = (
|
||||||
|
chartType: CartesianChartType,
|
||||||
|
seriesCount: number,
|
||||||
|
): CartesianChartLayout => {
|
||||||
|
if (chartType === "line") {
|
||||||
|
const slotWidth = getSeriesAwareSlotWidth(
|
||||||
|
CARTESIAN_LINE_SLOT_WIDTH,
|
||||||
|
seriesCount,
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
slotWidth,
|
||||||
|
gap: CARTESIAN_GAP,
|
||||||
|
chartHeight: CARTESIAN_LINE_HEIGHT,
|
||||||
|
xLabelMaxWidth:
|
||||||
|
slotWidth + CARTESIAN_GAP * 3 + CARTESIAN_LABEL_MAX_WIDTH_BUFFER,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const slotWidth = getSeriesAwareSlotWidth(
|
||||||
|
CARTESIAN_BASE_SLOT_WIDTH,
|
||||||
|
seriesCount,
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
slotWidth,
|
||||||
|
gap: CARTESIAN_GAP,
|
||||||
|
chartHeight: CARTESIAN_BAR_HEIGHT,
|
||||||
|
xLabelMaxWidth:
|
||||||
|
slotWidth + CARTESIAN_GAP * 3 + CARTESIAN_LABEL_MAX_WIDTH_BUFFER,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getChartDimensions = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
layout: CartesianChartLayout,
|
||||||
|
) => {
|
||||||
|
const chartWidth =
|
||||||
|
(layout.slotWidth + layout.gap) * spreadsheet.series[0].values.length +
|
||||||
|
layout.gap;
|
||||||
|
const chartHeight = layout.chartHeight + layout.gap * 2;
|
||||||
|
return { chartWidth, chartHeight };
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getRadarDimensions = () => {
|
||||||
|
const chartWidth = BAR_HEIGHT + RADAR_PADDING * 2;
|
||||||
|
const chartHeight = BAR_HEIGHT + RADAR_PADDING * 2;
|
||||||
|
return { chartWidth, chartHeight };
|
||||||
|
};
|
||||||
|
|
||||||
|
const getCircularDistance = (
|
||||||
|
firstIndex: number,
|
||||||
|
secondIndex: number,
|
||||||
|
paletteSize: number,
|
||||||
|
) => {
|
||||||
|
const absoluteDistance = Math.abs(firstIndex - secondIndex);
|
||||||
|
return Math.min(absoluteDistance, paletteSize - absoluteDistance);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getSeriesColors = (
|
||||||
|
seriesCount: number,
|
||||||
|
colorOffset: number,
|
||||||
|
): readonly string[] => {
|
||||||
|
if (seriesCount <= 0 || bgColors.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const paletteSize = bgColors.length;
|
||||||
|
const startIndex = ((colorOffset % paletteSize) + paletteSize) % paletteSize;
|
||||||
|
const selectedIndices = [startIndex];
|
||||||
|
const maxUniqueColors = Math.min(seriesCount, paletteSize);
|
||||||
|
const availableIndices = new Set(
|
||||||
|
Array.from({ length: paletteSize }, (_, index) => index).filter(
|
||||||
|
(index) => index !== startIndex,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
while (selectedIndices.length < maxUniqueColors) {
|
||||||
|
let bestIndex = -1;
|
||||||
|
let bestMinDistance = -1;
|
||||||
|
let bestAverageDistance = -1;
|
||||||
|
|
||||||
|
for (const candidateIndex of availableIndices) {
|
||||||
|
const distances = selectedIndices.map((selectedIndex) =>
|
||||||
|
getCircularDistance(candidateIndex, selectedIndex, paletteSize),
|
||||||
|
);
|
||||||
|
const minDistance = Math.min(...distances);
|
||||||
|
const averageDistance =
|
||||||
|
distances.reduce((total, distance) => total + distance, 0) /
|
||||||
|
distances.length;
|
||||||
|
|
||||||
|
if (
|
||||||
|
minDistance > bestMinDistance ||
|
||||||
|
(minDistance === bestMinDistance &&
|
||||||
|
averageDistance > bestAverageDistance)
|
||||||
|
) {
|
||||||
|
bestIndex = candidateIndex;
|
||||||
|
bestMinDistance = minDistance;
|
||||||
|
bestAverageDistance = averageDistance;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
selectedIndices.push(bestIndex);
|
||||||
|
availableIndices.delete(bestIndex);
|
||||||
|
}
|
||||||
|
|
||||||
|
return Array.from(
|
||||||
|
{ length: seriesCount },
|
||||||
|
(_, index) => bgColors[selectedIndices[index % selectedIndices.length]],
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getColorOffset = (colorSeed?: number) => {
|
||||||
|
if (bgColors.length === 0) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof colorSeed !== "number" || !Number.isFinite(colorSeed)) {
|
||||||
|
return Math.floor(Math.random() * bgColors.length);
|
||||||
|
}
|
||||||
|
|
||||||
|
const seedText = colorSeed.toString();
|
||||||
|
let hash = 0;
|
||||||
|
for (let index = 0; index < seedText.length; index++) {
|
||||||
|
hash = (hash * 31 + seedText.charCodeAt(index)) | 0;
|
||||||
|
}
|
||||||
|
return Math.abs(hash) % bgColors.length;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getBackgroundColor = (colorOffset: number) =>
|
||||||
|
bgColors[colorOffset];
|
||||||
|
|
||||||
|
export const getRadarValueScale = (
|
||||||
|
series: SpreadsheetSeries[],
|
||||||
|
_labelsLength: number,
|
||||||
|
) => {
|
||||||
|
const allValues = series.flatMap((s) =>
|
||||||
|
s.values.map((value) => Math.max(0, value)),
|
||||||
|
);
|
||||||
|
const positiveValues = allValues.filter((value) => value > 0);
|
||||||
|
const max = Math.max(1, ...allValues);
|
||||||
|
const minPositive =
|
||||||
|
positiveValues.length > 0 ? Math.min(...positiveValues) : 1;
|
||||||
|
const useLogScale =
|
||||||
|
series.length === 1 &&
|
||||||
|
minPositive > 0 &&
|
||||||
|
max / minPositive >= RADAR_SINGLE_SERIES_LOG_SCALE_THRESHOLD;
|
||||||
|
|
||||||
|
return {
|
||||||
|
renderSteps: false,
|
||||||
|
normalize: (value: number, _axisIndex: number) => {
|
||||||
|
const safeValue = Math.max(0, value);
|
||||||
|
return useLogScale
|
||||||
|
? Math.log10(safeValue + 1) / Math.log10(max + 1)
|
||||||
|
: safeValue / max;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
const shouldWrapRadarText = (text: string) => /\s/.test(text.trim());
|
||||||
|
|
||||||
|
export const getRadarDisplayText = (
|
||||||
|
text: string,
|
||||||
|
fontString: ReturnType<typeof getFontString>,
|
||||||
|
maxWidth: number,
|
||||||
|
) => {
|
||||||
|
return shouldWrapRadarText(text)
|
||||||
|
? wrapText(text, fontString, maxWidth)
|
||||||
|
: text;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const createRadarAxisLabels = (
|
||||||
|
labels: readonly string[],
|
||||||
|
angles: readonly number[],
|
||||||
|
centerX: number,
|
||||||
|
centerY: number,
|
||||||
|
radius: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
): {
|
||||||
|
axisLabels: ChartElements;
|
||||||
|
axisLabelTopY: number;
|
||||||
|
axisLabelBottomY: number;
|
||||||
|
} => {
|
||||||
|
const fontFamily = FONT_FAMILY.Excalifont;
|
||||||
|
const fontSize = FONT_SIZES.sm;
|
||||||
|
const lineHeight = getLineHeight(fontFamily);
|
||||||
|
const fontString = getFontString({ fontFamily, fontSize });
|
||||||
|
const baseLabelWidth = Math.min(
|
||||||
|
RADAR_AXIS_LABEL_MAX_WIDTH,
|
||||||
|
radius * (labels.length > 8 ? 0.56 : 0.72),
|
||||||
|
);
|
||||||
|
const minLabelWidth = getApproxMinLineWidth(fontString, lineHeight);
|
||||||
|
|
||||||
|
const axisLabels = labels.map((label, index) => {
|
||||||
|
const angle = angles[index];
|
||||||
|
const longestWordWidth = Math.max(
|
||||||
|
0,
|
||||||
|
...label
|
||||||
|
.trim()
|
||||||
|
.split(/\s+/)
|
||||||
|
.filter(Boolean)
|
||||||
|
.map((word) => measureText(word, fontString, lineHeight).width),
|
||||||
|
);
|
||||||
|
const maxLabelWidth = Math.max(
|
||||||
|
minLabelWidth,
|
||||||
|
baseLabelWidth,
|
||||||
|
longestWordWidth,
|
||||||
|
);
|
||||||
|
const displayLabel = getRadarDisplayText(label, fontString, maxLabelWidth);
|
||||||
|
const metrics = measureText(displayLabel, fontString, lineHeight);
|
||||||
|
const cos = Math.cos(angle);
|
||||||
|
const sin = Math.sin(angle);
|
||||||
|
|
||||||
|
const textAlign: "left" | "center" | "right" =
|
||||||
|
cos > RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD
|
||||||
|
? "left"
|
||||||
|
: cos < -RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD
|
||||||
|
? "right"
|
||||||
|
: "center";
|
||||||
|
|
||||||
|
// Keep labels outside the radar ring by projecting text extents
|
||||||
|
// onto the axis direction.
|
||||||
|
const centerAlignedXExtent = textAlign === "center" ? metrics.width / 2 : 0;
|
||||||
|
const projectedExtent =
|
||||||
|
Math.abs(cos) * centerAlignedXExtent +
|
||||||
|
Math.abs(sin) * (metrics.height / 2);
|
||||||
|
const radialOffset =
|
||||||
|
RADAR_LABEL_OFFSET + projectedExtent + RADAR_AXIS_LABEL_CLEARANCE;
|
||||||
|
const anchorX = centerX + cos * (radius + radialOffset);
|
||||||
|
const anchorY = centerY + sin * (radius + radialOffset);
|
||||||
|
|
||||||
|
const yNudge =
|
||||||
|
sin > RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD
|
||||||
|
? BAR_GAP / 3
|
||||||
|
: sin < -RADAR_AXIS_LABEL_ALIGNMENT_THRESHOLD
|
||||||
|
? -BAR_GAP / 3
|
||||||
|
: 0;
|
||||||
|
|
||||||
|
return newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
text: displayLabel,
|
||||||
|
originalText: label,
|
||||||
|
x: anchorX,
|
||||||
|
y: anchorY + yNudge,
|
||||||
|
fontFamily,
|
||||||
|
fontSize,
|
||||||
|
lineHeight,
|
||||||
|
textAlign,
|
||||||
|
verticalAlign: "middle",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const axisLabelTopY = Math.min(...axisLabels.map((axisLabel) => axisLabel.y));
|
||||||
|
const axisLabelBottomY = Math.max(
|
||||||
|
...axisLabels.map((axisLabel) => axisLabel.y + axisLabel.height),
|
||||||
|
);
|
||||||
|
return { axisLabels, axisLabelTopY, axisLabelBottomY };
|
||||||
|
};
|
||||||
|
|
||||||
|
export const createSeriesLegend = (
|
||||||
|
series: SpreadsheetSeries[],
|
||||||
|
seriesColors: readonly string[],
|
||||||
|
centerX: number,
|
||||||
|
minLegendTopY: number,
|
||||||
|
fallbackLegendY: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
): ChartElements => {
|
||||||
|
if (series.length <= 1) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const fontFamily = FONT_FAMILY["Lilita One"];
|
||||||
|
const fontSize = FONT_SIZES.lg;
|
||||||
|
const lineHeight = getLineHeight(fontFamily);
|
||||||
|
const fontString = getFontString({ fontFamily, fontSize });
|
||||||
|
const legendItems = series.map((seriesItem, index) => {
|
||||||
|
const label = seriesItem.title?.trim() || `Series ${index + 1}`;
|
||||||
|
const displayLabel = getRadarDisplayText(label, fontString, BAR_HEIGHT);
|
||||||
|
const metrics = measureText(displayLabel, fontString, lineHeight);
|
||||||
|
const itemWidth =
|
||||||
|
RADAR_LEGEND_SWATCH_SIZE + RADAR_LEGEND_TEXT_GAP + metrics.width;
|
||||||
|
return {
|
||||||
|
label,
|
||||||
|
displayLabel,
|
||||||
|
color: seriesColors[index],
|
||||||
|
width: itemWidth,
|
||||||
|
height: metrics.height,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const maxLegendHalfHeight = Math.max(
|
||||||
|
RADAR_LEGEND_SWATCH_SIZE / 2,
|
||||||
|
...legendItems.map((item) => item.height / 2),
|
||||||
|
);
|
||||||
|
const legendY = Math.max(
|
||||||
|
fallbackLegendY,
|
||||||
|
minLegendTopY + maxLegendHalfHeight + RADAR_LABEL_OFFSET,
|
||||||
|
);
|
||||||
|
|
||||||
|
const pillPaddingX = RADAR_LEGEND_ITEM_GAP;
|
||||||
|
const pillPaddingY = RADAR_LEGEND_SWATCH_SIZE * 0.6;
|
||||||
|
const totalLegendWidth =
|
||||||
|
legendItems.reduce((total, item) => total + item.width, 0) +
|
||||||
|
RADAR_LEGEND_ITEM_GAP * Math.max(0, legendItems.length - 1);
|
||||||
|
const pillWidth = totalLegendWidth + pillPaddingX * 2;
|
||||||
|
const pillHeight = maxLegendHalfHeight * 2 + pillPaddingY * 2;
|
||||||
|
|
||||||
|
const legendElements: NonDeletedExcalidrawElement[] = [];
|
||||||
|
|
||||||
|
// rounded pill background
|
||||||
|
legendElements.push(
|
||||||
|
newElement({
|
||||||
|
...commonProps,
|
||||||
|
backgroundColor: "transparent",
|
||||||
|
type: "rectangle",
|
||||||
|
fillStyle: "solid",
|
||||||
|
strokeColor: COLOR_PALETTE.black,
|
||||||
|
x: centerX - pillWidth / 2,
|
||||||
|
y: legendY - pillHeight / 2,
|
||||||
|
width: pillWidth,
|
||||||
|
height: pillHeight,
|
||||||
|
roughness: ROUGHNESS.architect,
|
||||||
|
roundness: { type: ROUNDNESS.PROPORTIONAL_RADIUS },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
let cursorX = centerX - totalLegendWidth / 2;
|
||||||
|
|
||||||
|
legendItems.forEach((item) => {
|
||||||
|
// solid filled swatch
|
||||||
|
legendElements.push(
|
||||||
|
newElement({
|
||||||
|
...commonProps,
|
||||||
|
backgroundColor: item.color,
|
||||||
|
type: "rectangle",
|
||||||
|
x: cursorX,
|
||||||
|
y: legendY - RADAR_LEGEND_SWATCH_SIZE / 2,
|
||||||
|
width: RADAR_LEGEND_SWATCH_SIZE,
|
||||||
|
height: RADAR_LEGEND_SWATCH_SIZE,
|
||||||
|
fillStyle: "solid",
|
||||||
|
strokeColor: item.color,
|
||||||
|
roughness: ROUGHNESS.architect,
|
||||||
|
roundness: { type: ROUNDNESS.PROPORTIONAL_RADIUS },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
// label in default (black) color
|
||||||
|
legendElements.push(
|
||||||
|
newTextElement({
|
||||||
|
...commonProps,
|
||||||
|
text: item.displayLabel,
|
||||||
|
originalText: item.label,
|
||||||
|
autoResize: false,
|
||||||
|
x: cursorX + RADAR_LEGEND_SWATCH_SIZE + RADAR_LEGEND_TEXT_GAP,
|
||||||
|
y: legendY,
|
||||||
|
fontFamily,
|
||||||
|
fontSize,
|
||||||
|
lineHeight,
|
||||||
|
textAlign: "left",
|
||||||
|
verticalAlign: "middle",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
cursorX += item.width + RADAR_LEGEND_ITEM_GAP;
|
||||||
|
});
|
||||||
|
|
||||||
|
return legendElements;
|
||||||
|
};
|
||||||
|
|
||||||
|
const ellipsifyTextToWidth = (
|
||||||
|
text: string,
|
||||||
|
maxWidth: number,
|
||||||
|
fontString: ReturnType<typeof getFontString>,
|
||||||
|
lineHeight: ExcalidrawTextElement["lineHeight"],
|
||||||
|
) => {
|
||||||
|
if (measureText(text, fontString, lineHeight).width <= maxWidth) {
|
||||||
|
return text;
|
||||||
|
}
|
||||||
|
|
||||||
|
let end = text.length;
|
||||||
|
while (end > 1) {
|
||||||
|
const candidate = `${text.slice(0, end)}...`;
|
||||||
|
if (measureText(candidate, fontString, lineHeight).width <= maxWidth) {
|
||||||
|
return candidate;
|
||||||
|
}
|
||||||
|
end--;
|
||||||
|
}
|
||||||
|
|
||||||
|
return text[0] ? `${text[0]}...` : text;
|
||||||
|
};
|
||||||
|
|
||||||
|
const wrapOrEllipsifyTextToWidth = (
|
||||||
|
text: string,
|
||||||
|
maxWidth: number,
|
||||||
|
fontString: ReturnType<typeof getFontString>,
|
||||||
|
lineHeight: ExcalidrawTextElement["lineHeight"],
|
||||||
|
) => {
|
||||||
|
if (measureText(text, fontString, lineHeight).width <= maxWidth) {
|
||||||
|
return { wrapped: false, text };
|
||||||
|
}
|
||||||
|
|
||||||
|
const words = text.trim().split(/\s+/).filter(Boolean);
|
||||||
|
if (words.length > 1) {
|
||||||
|
const hasLongWord = words.some((word) => {
|
||||||
|
return measureText(word, fontString, lineHeight).width > maxWidth;
|
||||||
|
});
|
||||||
|
if (
|
||||||
|
!hasLongWord &&
|
||||||
|
maxWidth >= getApproxMinLineWidth(fontString, lineHeight)
|
||||||
|
) {
|
||||||
|
return { wrapped: true, text: wrapText(text, fontString, maxWidth) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
wrapped: false,
|
||||||
|
text: ellipsifyTextToWidth(text, maxWidth, fontString, lineHeight),
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
const getRotatedBoundingBox = (
|
||||||
|
width: number,
|
||||||
|
height: number,
|
||||||
|
angle: number,
|
||||||
|
) => {
|
||||||
|
const cos = Math.abs(Math.cos(angle));
|
||||||
|
const sin = Math.abs(Math.sin(angle));
|
||||||
|
return {
|
||||||
|
width: width * cos + height * sin,
|
||||||
|
height: width * sin + height * cos,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
type CartesianAxisLabelSpec = {
|
||||||
|
originalText: string;
|
||||||
|
text: string;
|
||||||
|
wrapped: boolean;
|
||||||
|
metrics: ReturnType<typeof measureText>;
|
||||||
|
rotatedWidth: number;
|
||||||
|
rotatedHeight: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
const isEllipsifiedLabel = (text: string) => text.includes("...");
|
||||||
|
|
||||||
|
const getCartesianAxisLabelSpec = (
|
||||||
|
label: string,
|
||||||
|
maxLabelWidth: number,
|
||||||
|
maxRotatedWidth: number,
|
||||||
|
fontString: ReturnType<typeof getFontString>,
|
||||||
|
lineHeight: ExcalidrawTextElement["lineHeight"],
|
||||||
|
): CartesianAxisLabelSpec => {
|
||||||
|
const minWidth = Math.max(
|
||||||
|
CARTESIAN_LABEL_MIN_WIDTH,
|
||||||
|
Math.ceil(getApproxMinLineWidth(fontString, lineHeight)),
|
||||||
|
);
|
||||||
|
const maxWidth = Math.max(minWidth, Math.floor(maxLabelWidth));
|
||||||
|
const candidateWidths: number[] = [];
|
||||||
|
for (let width = maxWidth; width >= minWidth; width -= 4) {
|
||||||
|
candidateWidths.push(width);
|
||||||
|
}
|
||||||
|
if (candidateWidths[candidateWidths.length - 1] !== minWidth) {
|
||||||
|
candidateWidths.push(minWidth);
|
||||||
|
}
|
||||||
|
|
||||||
|
const getRank = (spec: CartesianAxisLabelSpec) => {
|
||||||
|
const ellipsified = isEllipsifiedLabel(spec.text);
|
||||||
|
const visibleChars = spec.text
|
||||||
|
.replace(/\.\.\./g, "")
|
||||||
|
.replace(/\n/g, "").length;
|
||||||
|
const lineCount = spec.text.split("\n").length;
|
||||||
|
return {
|
||||||
|
ellipsified,
|
||||||
|
visibleChars,
|
||||||
|
lineCount,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
const shouldPrefer = (
|
||||||
|
candidate: CartesianAxisLabelSpec,
|
||||||
|
current: CartesianAxisLabelSpec,
|
||||||
|
) => {
|
||||||
|
const candidateRank = getRank(candidate);
|
||||||
|
const currentRank = getRank(current);
|
||||||
|
if (candidateRank.ellipsified !== currentRank.ellipsified) {
|
||||||
|
return !candidateRank.ellipsified;
|
||||||
|
}
|
||||||
|
if (candidateRank.visibleChars !== currentRank.visibleChars) {
|
||||||
|
return candidateRank.visibleChars > currentRank.visibleChars;
|
||||||
|
}
|
||||||
|
if (candidateRank.lineCount !== currentRank.lineCount) {
|
||||||
|
return candidateRank.lineCount < currentRank.lineCount;
|
||||||
|
}
|
||||||
|
return candidate.rotatedHeight < current.rotatedHeight;
|
||||||
|
};
|
||||||
|
|
||||||
|
let bestFit: CartesianAxisLabelSpec | null = null;
|
||||||
|
let bestOverflowAny: {
|
||||||
|
overflow: number;
|
||||||
|
spec: CartesianAxisLabelSpec;
|
||||||
|
} | null = null;
|
||||||
|
let bestOverflowNonEllipsified: {
|
||||||
|
overflow: number;
|
||||||
|
spec: CartesianAxisLabelSpec;
|
||||||
|
} | null = null;
|
||||||
|
|
||||||
|
for (const width of candidateWidths) {
|
||||||
|
const { wrapped, text } = wrapOrEllipsifyTextToWidth(
|
||||||
|
label,
|
||||||
|
width,
|
||||||
|
fontString,
|
||||||
|
lineHeight,
|
||||||
|
);
|
||||||
|
const metrics = measureText(text, fontString, lineHeight);
|
||||||
|
const rotated = getRotatedBoundingBox(
|
||||||
|
metrics.width,
|
||||||
|
metrics.height,
|
||||||
|
CARTESIAN_LABEL_ROTATION,
|
||||||
|
);
|
||||||
|
const spec = {
|
||||||
|
originalText: label,
|
||||||
|
text,
|
||||||
|
metrics,
|
||||||
|
rotatedWidth: rotated.width,
|
||||||
|
rotatedHeight: rotated.height,
|
||||||
|
wrapped,
|
||||||
|
};
|
||||||
|
const overflow = rotated.width - maxRotatedWidth;
|
||||||
|
if (overflow <= 0) {
|
||||||
|
if (!bestFit || shouldPrefer(spec, bestFit)) {
|
||||||
|
bestFit = spec;
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!bestOverflowAny ||
|
||||||
|
overflow < bestOverflowAny.overflow ||
|
||||||
|
(overflow === bestOverflowAny.overflow &&
|
||||||
|
shouldPrefer(spec, bestOverflowAny.spec))
|
||||||
|
) {
|
||||||
|
bestOverflowAny = { overflow, spec };
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!isEllipsifiedLabel(spec.text) &&
|
||||||
|
(!bestOverflowNonEllipsified ||
|
||||||
|
overflow < bestOverflowNonEllipsified.overflow ||
|
||||||
|
(overflow === bestOverflowNonEllipsified.overflow &&
|
||||||
|
shouldPrefer(spec, bestOverflowNonEllipsified.spec)))
|
||||||
|
) {
|
||||||
|
bestOverflowNonEllipsified = { overflow, spec };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (bestFit) {
|
||||||
|
return bestFit;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
bestOverflowNonEllipsified &&
|
||||||
|
bestOverflowAny &&
|
||||||
|
bestOverflowNonEllipsified.overflow <=
|
||||||
|
bestOverflowAny.overflow + CARTESIAN_LABEL_OVERFLOW_PREFERENCE_BUFFER
|
||||||
|
) {
|
||||||
|
return bestOverflowNonEllipsified.spec;
|
||||||
|
}
|
||||||
|
|
||||||
|
return bestOverflowAny!.spec;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getRotatedTextElementBottom = (
|
||||||
|
element: NonDeletedExcalidrawElement,
|
||||||
|
) => {
|
||||||
|
if (element.type !== "text") {
|
||||||
|
return element.y + element.height;
|
||||||
|
}
|
||||||
|
const rotated = getRotatedBoundingBox(
|
||||||
|
element.width,
|
||||||
|
element.height,
|
||||||
|
element.angle,
|
||||||
|
);
|
||||||
|
return element.y + element.height / 2 + rotated.height / 2;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const chartXLabels = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
layout: CartesianChartLayout,
|
||||||
|
): ChartElements => {
|
||||||
|
const fontFamily = commonProps.fontFamily;
|
||||||
|
const fontSize = FONT_SIZES.sm;
|
||||||
|
const lineHeight = getLineHeight(fontFamily);
|
||||||
|
const fontString = getFontString({ fontFamily, fontSize });
|
||||||
|
const maxRotatedWidth = Math.max(
|
||||||
|
1,
|
||||||
|
layout.slotWidth +
|
||||||
|
layout.gap -
|
||||||
|
CARTESIAN_LABEL_SLOT_PADDING * 2 +
|
||||||
|
CARTESIAN_LABEL_ROTATED_WIDTH_BUFFER,
|
||||||
|
);
|
||||||
|
const axisY = y;
|
||||||
|
|
||||||
|
return (
|
||||||
|
spreadsheet.labels?.map((label, index) => {
|
||||||
|
const labelSpec = getCartesianAxisLabelSpec(
|
||||||
|
label,
|
||||||
|
layout.xLabelMaxWidth,
|
||||||
|
maxRotatedWidth,
|
||||||
|
fontString,
|
||||||
|
lineHeight,
|
||||||
|
);
|
||||||
|
const centerX =
|
||||||
|
x +
|
||||||
|
index * (layout.slotWidth + layout.gap) +
|
||||||
|
layout.gap +
|
||||||
|
layout.slotWidth / 2;
|
||||||
|
const labelY =
|
||||||
|
axisY +
|
||||||
|
CARTESIAN_LABEL_AXIS_CLEARANCE +
|
||||||
|
(labelSpec.rotatedHeight - labelSpec.metrics.height) / 2;
|
||||||
|
|
||||||
|
return newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
text: labelSpec.text,
|
||||||
|
originalText: labelSpec.wrapped ? label : labelSpec.text,
|
||||||
|
autoResize: !labelSpec.wrapped,
|
||||||
|
x: centerX,
|
||||||
|
y: labelY,
|
||||||
|
angle: CARTESIAN_LABEL_ROTATION,
|
||||||
|
fontSize,
|
||||||
|
lineHeight,
|
||||||
|
textAlign: "center",
|
||||||
|
verticalAlign: "top",
|
||||||
|
});
|
||||||
|
}) || []
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const chartYLabels = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
layout: CartesianChartLayout,
|
||||||
|
maxValue = Math.max(...spreadsheet.series[0].values),
|
||||||
|
): ChartElements => {
|
||||||
|
const minYLabel = newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
x: x - layout.gap,
|
||||||
|
y: y - layout.gap,
|
||||||
|
text: "0",
|
||||||
|
textAlign: "right",
|
||||||
|
});
|
||||||
|
|
||||||
|
const maxYLabel = newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
x: x - layout.gap,
|
||||||
|
y: y - layout.chartHeight - minYLabel.height / 2,
|
||||||
|
text: maxValue.toLocaleString(),
|
||||||
|
textAlign: "right",
|
||||||
|
});
|
||||||
|
|
||||||
|
return [minYLabel, maxYLabel];
|
||||||
|
};
|
||||||
|
|
||||||
|
const chartLines = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
layout: CartesianChartLayout,
|
||||||
|
): ChartElements => {
|
||||||
|
const { chartWidth, chartHeight } = getChartDimensions(spreadsheet, layout);
|
||||||
|
const xLine = newLinearElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
width: chartWidth,
|
||||||
|
points: [pointFrom(0, 0), pointFrom(chartWidth, 0)],
|
||||||
|
});
|
||||||
|
|
||||||
|
const yLine = newLinearElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
height: chartHeight,
|
||||||
|
points: [pointFrom(0, 0), pointFrom(0, -chartHeight)],
|
||||||
|
});
|
||||||
|
|
||||||
|
const maxLine = newLinearElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x,
|
||||||
|
y: y - layout.chartHeight - layout.gap,
|
||||||
|
strokeStyle: "dotted",
|
||||||
|
width: chartWidth,
|
||||||
|
opacity: GRID_OPACITY,
|
||||||
|
points: [pointFrom(0, 0), pointFrom(chartWidth, 0)],
|
||||||
|
});
|
||||||
|
|
||||||
|
return [xLine, yLine, maxLine];
|
||||||
|
};
|
||||||
|
|
||||||
|
// For the maths behind it https://excalidraw.com/#json=6320864370884608,O_5xfD-Agh32tytHpRJx1g
|
||||||
|
export const chartBaseElements = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
backgroundColor: string,
|
||||||
|
layout: CartesianChartLayout,
|
||||||
|
maxValue = Math.max(...spreadsheet.series[0].values),
|
||||||
|
debug?: boolean,
|
||||||
|
): ChartElements => {
|
||||||
|
const { chartWidth, chartHeight } = getChartDimensions(spreadsheet, layout);
|
||||||
|
|
||||||
|
const title = spreadsheet.title
|
||||||
|
? newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
text: spreadsheet.title,
|
||||||
|
x: x + chartWidth / 2,
|
||||||
|
y: y - layout.chartHeight - layout.gap * 2 - DEFAULT_FONT_SIZE,
|
||||||
|
roundness: null,
|
||||||
|
textAlign: "center",
|
||||||
|
fontSize: FONT_SIZES.xl,
|
||||||
|
fontFamily: FONT_FAMILY["Lilita One"],
|
||||||
|
})
|
||||||
|
: null;
|
||||||
|
|
||||||
|
const debugRect = debug
|
||||||
|
? newElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "rectangle",
|
||||||
|
x,
|
||||||
|
y: y - chartHeight,
|
||||||
|
width: chartWidth,
|
||||||
|
height: chartHeight,
|
||||||
|
strokeColor: COLOR_PALETTE.black,
|
||||||
|
fillStyle: "solid",
|
||||||
|
opacity: 6,
|
||||||
|
})
|
||||||
|
: null;
|
||||||
|
|
||||||
|
return [
|
||||||
|
...(debugRect ? [debugRect] : []),
|
||||||
|
...(title ? [title] : []),
|
||||||
|
...chartXLabels(spreadsheet, x, y, backgroundColor, layout),
|
||||||
|
...chartYLabels(spreadsheet, x, y, backgroundColor, layout, maxValue),
|
||||||
|
...chartLines(spreadsheet, x, y, backgroundColor, layout),
|
||||||
|
];
|
||||||
|
};
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
import { pointFrom } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import { isDevEnv } from "@excalidraw/common";
|
||||||
|
|
||||||
|
import { newElement, newLinearElement } from "@excalidraw/element";
|
||||||
|
|
||||||
|
import type { LocalPoint } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import { GRID_OPACITY, commonProps } from "./charts.constants";
|
||||||
|
import {
|
||||||
|
chartBaseElements,
|
||||||
|
chartXLabels,
|
||||||
|
createSeriesLegend,
|
||||||
|
getBackgroundColor,
|
||||||
|
getCartesianChartLayout,
|
||||||
|
getChartDimensions,
|
||||||
|
getColorOffset,
|
||||||
|
getRotatedTextElementBottom,
|
||||||
|
getSeriesColors,
|
||||||
|
} from "./charts.helpers";
|
||||||
|
|
||||||
|
import type { ChartElements, Spreadsheet } from "./charts.types";
|
||||||
|
|
||||||
|
export const renderLineChart = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
colorSeed?: number,
|
||||||
|
): ChartElements => {
|
||||||
|
const series = spreadsheet.series;
|
||||||
|
const layout = getCartesianChartLayout("line", series.length);
|
||||||
|
const max = Math.max(1, ...series.flatMap((seriesData) => seriesData.values));
|
||||||
|
const colorOffset = getColorOffset(colorSeed);
|
||||||
|
const backgroundColor = getBackgroundColor(colorOffset);
|
||||||
|
const seriesColors = getSeriesColors(series.length, colorOffset);
|
||||||
|
|
||||||
|
const lines = series.map((seriesData, seriesIndex) => {
|
||||||
|
const points = seriesData.values.map((value, valueIndex) =>
|
||||||
|
pointFrom<LocalPoint>(
|
||||||
|
valueIndex * (layout.slotWidth + layout.gap),
|
||||||
|
-(value / max) * layout.chartHeight,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
const maxX = Math.max(...points.map((point) => point[0]));
|
||||||
|
const maxY = Math.max(...points.map((point) => point[1]));
|
||||||
|
const minX = Math.min(...points.map((point) => point[0]));
|
||||||
|
const minY = Math.min(...points.map((point) => point[1]));
|
||||||
|
|
||||||
|
return newLinearElement({
|
||||||
|
backgroundColor: "transparent",
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x: x + layout.gap + layout.slotWidth / 2,
|
||||||
|
y: y - layout.gap,
|
||||||
|
height: maxY - minY,
|
||||||
|
width: maxX - minX,
|
||||||
|
strokeColor: seriesColors[seriesIndex],
|
||||||
|
strokeWidth: 2,
|
||||||
|
points,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const dots = series.flatMap((seriesData, seriesIndex) =>
|
||||||
|
seriesData.values.map((value, valueIndex) => {
|
||||||
|
const cx = valueIndex * (layout.slotWidth + layout.gap) + layout.gap / 2;
|
||||||
|
const cy = -(value / max) * layout.chartHeight + layout.gap / 2;
|
||||||
|
return newElement({
|
||||||
|
backgroundColor: seriesColors[seriesIndex],
|
||||||
|
...commonProps,
|
||||||
|
fillStyle: "solid",
|
||||||
|
strokeColor: seriesColors[seriesIndex],
|
||||||
|
strokeWidth: 2,
|
||||||
|
type: "ellipse",
|
||||||
|
x: x + cx + layout.slotWidth / 2,
|
||||||
|
y: y + cy - layout.gap * 2,
|
||||||
|
width: layout.gap,
|
||||||
|
height: layout.gap,
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const guideValues = series[0].values.map((_, valueIndex) =>
|
||||||
|
Math.max(
|
||||||
|
0,
|
||||||
|
...series.map((seriesData) => seriesData.values[valueIndex] ?? 0),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const guides = guideValues.map((value, valueIndex) => {
|
||||||
|
const cx = valueIndex * (layout.slotWidth + layout.gap) + layout.gap / 2;
|
||||||
|
const cy = (value / max) * layout.chartHeight + layout.gap / 2 + layout.gap;
|
||||||
|
return newLinearElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x: x + cx + layout.slotWidth / 2 + layout.gap / 2,
|
||||||
|
y: y - cy,
|
||||||
|
height: cy,
|
||||||
|
strokeStyle: "dotted",
|
||||||
|
opacity: GRID_OPACITY,
|
||||||
|
points: [pointFrom(0, 0), pointFrom(0, cy)],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const baseElements = chartBaseElements(
|
||||||
|
spreadsheet,
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
backgroundColor,
|
||||||
|
layout,
|
||||||
|
max,
|
||||||
|
isDevEnv(),
|
||||||
|
);
|
||||||
|
const xLabels = chartXLabels(spreadsheet, x, y, backgroundColor, layout);
|
||||||
|
const xLabelsBottomY = Math.max(
|
||||||
|
y + layout.gap / 2,
|
||||||
|
...xLabels.map((label) => getRotatedTextElementBottom(label)),
|
||||||
|
);
|
||||||
|
const { chartWidth } = getChartDimensions(spreadsheet, layout);
|
||||||
|
const seriesLegend = createSeriesLegend(
|
||||||
|
series,
|
||||||
|
seriesColors,
|
||||||
|
x + chartWidth / 2,
|
||||||
|
xLabelsBottomY,
|
||||||
|
y + layout.gap * 5,
|
||||||
|
backgroundColor,
|
||||||
|
);
|
||||||
|
|
||||||
|
return [...baseElements, ...lines, ...guides, ...dots, ...seriesLegend];
|
||||||
|
};
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
import { type ParseSpreadsheetResult } from "./charts.types";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private exported for testing
|
||||||
|
*/
|
||||||
|
export const tryParseNumber = (s: string): number | null => {
|
||||||
|
const match =
|
||||||
|
/^([-+]?)[$\u20AC\u00A3\u00A5\u20A9]?([-+]?)([\d.,]+)[%]?$/.exec(s);
|
||||||
|
if (!match) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return parseFloat(`${(match[1] || match[2]) + match[3]}`.replace(/,/g, ""));
|
||||||
|
};
|
||||||
|
|
||||||
|
const isNumericColumn = (lines: string[][], columnIndex: number) =>
|
||||||
|
lines.slice(1).every((line) => tryParseNumber(line[columnIndex]) !== null);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private exported for testing
|
||||||
|
*/
|
||||||
|
export const tryParseCells = (cells: string[][]): ParseSpreadsheetResult => {
|
||||||
|
const numCols = cells[0].length;
|
||||||
|
|
||||||
|
if (numCols > 2) {
|
||||||
|
const hasHeader = cells[0].every((cell) => tryParseNumber(cell) === null);
|
||||||
|
const rows = hasHeader ? cells.slice(1) : cells;
|
||||||
|
|
||||||
|
if (rows.length < 1) {
|
||||||
|
return { ok: false, reason: "No data rows" };
|
||||||
|
}
|
||||||
|
|
||||||
|
const invalidNumericColumn = rows.some((row) =>
|
||||||
|
row.slice(1).some((value) => tryParseNumber(value) === null),
|
||||||
|
);
|
||||||
|
if (invalidNumericColumn) {
|
||||||
|
return { ok: false, reason: "Value is not numeric" };
|
||||||
|
}
|
||||||
|
|
||||||
|
// When there are more value columns than data rows, the data is in
|
||||||
|
// "wide" format — transpose so columns become labels (dimensions)
|
||||||
|
// and rows become series. This enables e.g. radar charts for wide data.
|
||||||
|
const numValueCols = numCols - 1;
|
||||||
|
if (numValueCols > rows.length) {
|
||||||
|
const labels = hasHeader ? cells[0].slice(1).map((h) => h.trim()) : null;
|
||||||
|
const series = rows.map((row) => ({
|
||||||
|
title: row[0]?.trim() || null,
|
||||||
|
values: row.slice(1).map((v) => tryParseNumber(v)!),
|
||||||
|
}));
|
||||||
|
const title =
|
||||||
|
series.length === 1
|
||||||
|
? series[0].title
|
||||||
|
: hasHeader
|
||||||
|
? cells[0][0].trim() || null
|
||||||
|
: null;
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
data: { title, labels, series },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const series = cells[0].slice(1).map((seriesTitle, index) => {
|
||||||
|
const valueColumnIndex = index + 1;
|
||||||
|
const fallbackTitle = `Series ${valueColumnIndex}`;
|
||||||
|
return {
|
||||||
|
title: hasHeader ? seriesTitle.trim() || fallbackTitle : fallbackTitle,
|
||||||
|
values: rows.map((row) => tryParseNumber(row[valueColumnIndex])!),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
data: {
|
||||||
|
title: hasHeader ? cells[0][0].trim() || null : null,
|
||||||
|
labels: rows.map((row) => row[0]),
|
||||||
|
series,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (numCols === 1) {
|
||||||
|
if (!isNumericColumn(cells, 0)) {
|
||||||
|
return { ok: false, reason: "Value is not numeric" };
|
||||||
|
}
|
||||||
|
|
||||||
|
const hasHeader = tryParseNumber(cells[0][0]) === null;
|
||||||
|
const title = hasHeader ? cells[0][0] : null;
|
||||||
|
const values = (hasHeader ? cells.slice(1) : cells).map((line) =>
|
||||||
|
tryParseNumber(line[0]),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (values.length < 2) {
|
||||||
|
return { ok: false, reason: "Less than two rows" };
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
data: {
|
||||||
|
title,
|
||||||
|
labels: null,
|
||||||
|
series: [{ title, values: values as number[] }],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const hasHeader = tryParseNumber(cells[0][1]) === null;
|
||||||
|
const rows = hasHeader ? cells.slice(1) : cells;
|
||||||
|
|
||||||
|
if (rows.length < 2) {
|
||||||
|
return { ok: false, reason: "Less than 2 rows" };
|
||||||
|
}
|
||||||
|
|
||||||
|
const invalidNumericColumn = rows.some(
|
||||||
|
(row) => tryParseNumber(row[1]) === null,
|
||||||
|
);
|
||||||
|
if (invalidNumericColumn) {
|
||||||
|
return { ok: false, reason: "Value is not numeric" };
|
||||||
|
}
|
||||||
|
|
||||||
|
const title = hasHeader ? cells[0][1] : null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
data: {
|
||||||
|
title,
|
||||||
|
labels: rows.map((row) => row[0]),
|
||||||
|
series: [{ title, values: rows.map((row) => tryParseNumber(row[1])!) }],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const tryParseSpreadsheet = (text: string): ParseSpreadsheetResult => {
|
||||||
|
// Copy/paste from excel, spreadsheets, TSV, CSV, semicolon-separated.
|
||||||
|
const parseDelimitedLines = (delimiter: "\t" | "," | ";") =>
|
||||||
|
text
|
||||||
|
.replace(/\r\n?/g, "\n")
|
||||||
|
.split("\n")
|
||||||
|
.filter((line) => line.trim().length > 0)
|
||||||
|
.map((line) => line.split(delimiter).map((cell) => cell.trim()));
|
||||||
|
|
||||||
|
// Score each delimiter: prefer consistent column counts with the most columns.
|
||||||
|
// A delimiter that produces all single-column rows likely isn't the right one.
|
||||||
|
const candidates = (["\t", ",", ";"] as const).map((delimiter) => {
|
||||||
|
const parsed = parseDelimitedLines(delimiter);
|
||||||
|
const numCols = parsed[0]?.length ?? 0;
|
||||||
|
const isConsistent =
|
||||||
|
parsed.length > 0 && parsed.every((line) => line.length === numCols);
|
||||||
|
return { delimiter, parsed, numCols, isConsistent };
|
||||||
|
});
|
||||||
|
|
||||||
|
// Prefer: consistent + most columns. Among ties, tab > comma > semicolon
|
||||||
|
// (the array order already encodes this priority).
|
||||||
|
const best =
|
||||||
|
candidates.find((c) => c.isConsistent && c.numCols > 1) ??
|
||||||
|
candidates.find((c) => c.isConsistent) ??
|
||||||
|
candidates[0];
|
||||||
|
|
||||||
|
const lines = best.parsed;
|
||||||
|
|
||||||
|
if (lines.length === 0) {
|
||||||
|
return { ok: false, reason: "No values" };
|
||||||
|
}
|
||||||
|
|
||||||
|
const numColsFirstLine = lines[0].length;
|
||||||
|
const isSpreadsheet = lines.every((line) => line.length === numColsFirstLine);
|
||||||
|
|
||||||
|
if (!isSpreadsheet) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
reason: "All rows don't have same number of columns",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return tryParseCells(lines);
|
||||||
|
};
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
import { pointFrom } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import {
|
||||||
|
FONT_FAMILY,
|
||||||
|
FONT_SIZES,
|
||||||
|
getFontString,
|
||||||
|
getLineHeight,
|
||||||
|
ROUGHNESS,
|
||||||
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
|
import {
|
||||||
|
measureText,
|
||||||
|
newLinearElement,
|
||||||
|
newTextElement,
|
||||||
|
} from "@excalidraw/element";
|
||||||
|
|
||||||
|
import type { LocalPoint } from "@excalidraw/math";
|
||||||
|
|
||||||
|
import {
|
||||||
|
BAR_GAP,
|
||||||
|
BAR_HEIGHT,
|
||||||
|
GRID_OPACITY,
|
||||||
|
RADAR_GRID_LEVELS,
|
||||||
|
RADAR_LABEL_OFFSET,
|
||||||
|
commonProps,
|
||||||
|
} from "./charts.constants";
|
||||||
|
import {
|
||||||
|
createRadarAxisLabels,
|
||||||
|
createSeriesLegend,
|
||||||
|
getBackgroundColor,
|
||||||
|
getColorOffset,
|
||||||
|
getRadarDimensions,
|
||||||
|
getRadarDisplayText,
|
||||||
|
getRadarValueScale,
|
||||||
|
getSeriesColors,
|
||||||
|
isSpreadsheetValidForChartType,
|
||||||
|
} from "./charts.helpers";
|
||||||
|
|
||||||
|
import type { ChartElements, Spreadsheet } from "./charts.types";
|
||||||
|
|
||||||
|
export const renderRadarChart = (
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
colorSeed?: number,
|
||||||
|
): ChartElements | null => {
|
||||||
|
if (!isSpreadsheetValidForChartType(spreadsheet, "radar")) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const labels =
|
||||||
|
spreadsheet.labels ??
|
||||||
|
spreadsheet.series[0].values.map((_, index) => `Value ${index + 1}`);
|
||||||
|
|
||||||
|
const series = spreadsheet.series;
|
||||||
|
const { normalize, renderSteps } = getRadarValueScale(series, labels.length);
|
||||||
|
const colorOffset = getColorOffset(colorSeed);
|
||||||
|
const backgroundColor = getBackgroundColor(colorOffset);
|
||||||
|
const seriesColors = getSeriesColors(series.length, colorOffset);
|
||||||
|
const { chartWidth, chartHeight } = getRadarDimensions();
|
||||||
|
const centerX = x + chartWidth / 2;
|
||||||
|
const centerY = y - chartHeight / 2;
|
||||||
|
const radius = BAR_HEIGHT / 2;
|
||||||
|
const angles = labels.map(
|
||||||
|
(_, index) => -Math.PI / 2 + (Math.PI * 2 * index) / labels.length,
|
||||||
|
);
|
||||||
|
|
||||||
|
const { axisLabels, axisLabelTopY, axisLabelBottomY } = createRadarAxisLabels(
|
||||||
|
labels,
|
||||||
|
angles,
|
||||||
|
centerX,
|
||||||
|
centerY,
|
||||||
|
radius,
|
||||||
|
backgroundColor,
|
||||||
|
);
|
||||||
|
|
||||||
|
const titleFontFamily = FONT_FAMILY["Lilita One"];
|
||||||
|
const titleFontSize = FONT_SIZES.xl;
|
||||||
|
const titleLineHeight = getLineHeight(titleFontFamily);
|
||||||
|
const titleFontString = getFontString({
|
||||||
|
fontFamily: titleFontFamily,
|
||||||
|
fontSize: titleFontSize,
|
||||||
|
});
|
||||||
|
const titleText = spreadsheet.title
|
||||||
|
? getRadarDisplayText(
|
||||||
|
spreadsheet.title,
|
||||||
|
titleFontString,
|
||||||
|
chartWidth + RADAR_LABEL_OFFSET * 2,
|
||||||
|
)
|
||||||
|
: null;
|
||||||
|
const titleTextMetrics = titleText
|
||||||
|
? measureText(titleText, titleFontString, titleLineHeight)
|
||||||
|
: null;
|
||||||
|
const title = titleText
|
||||||
|
? newTextElement({
|
||||||
|
backgroundColor,
|
||||||
|
...commonProps,
|
||||||
|
text: titleText,
|
||||||
|
originalText: spreadsheet.title ?? titleText,
|
||||||
|
x: x + chartWidth / 2,
|
||||||
|
y: axisLabelTopY - RADAR_LABEL_OFFSET - titleTextMetrics!.height / 2,
|
||||||
|
fontFamily: titleFontFamily,
|
||||||
|
fontSize: titleFontSize,
|
||||||
|
lineHeight: titleLineHeight,
|
||||||
|
textAlign: "center",
|
||||||
|
})
|
||||||
|
: null;
|
||||||
|
|
||||||
|
const radarGridLines = renderSteps
|
||||||
|
? Array.from({ length: RADAR_GRID_LEVELS }, (_, levelIndex) => {
|
||||||
|
const levelRatio = (levelIndex + 1) / RADAR_GRID_LEVELS;
|
||||||
|
const levelRadius = radius * levelRatio;
|
||||||
|
const points = angles.map((angle) =>
|
||||||
|
pointFrom<LocalPoint>(
|
||||||
|
Math.cos(angle) * levelRadius,
|
||||||
|
Math.sin(angle) * levelRadius,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
points.push(pointFrom(points[0][0], points[0][1]));
|
||||||
|
|
||||||
|
return newLinearElement({
|
||||||
|
backgroundColor: "transparent",
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x: centerX,
|
||||||
|
y: centerY,
|
||||||
|
width: levelRadius * 2,
|
||||||
|
height: levelRadius * 2,
|
||||||
|
strokeStyle: "solid",
|
||||||
|
roughness: ROUGHNESS.architect,
|
||||||
|
opacity: GRID_OPACITY,
|
||||||
|
polygon: true,
|
||||||
|
points,
|
||||||
|
});
|
||||||
|
})
|
||||||
|
: [];
|
||||||
|
|
||||||
|
const spokes = angles.map((angle) => {
|
||||||
|
const px = Math.cos(angle) * radius;
|
||||||
|
const py = Math.sin(angle) * radius;
|
||||||
|
return newLinearElement({
|
||||||
|
backgroundColor: "transparent",
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x: centerX,
|
||||||
|
y: centerY,
|
||||||
|
width: Math.abs(px),
|
||||||
|
height: Math.abs(py),
|
||||||
|
strokeStyle: "solid",
|
||||||
|
roughness: ROUGHNESS.architect,
|
||||||
|
opacity: GRID_OPACITY,
|
||||||
|
points: [pointFrom(0, 0), pointFrom(px, py)],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const seriesPolygons = series.map((seriesData, index) => {
|
||||||
|
const points = angles.map((angle, axisIndex) => {
|
||||||
|
const value = seriesData.values[axisIndex] ?? 0;
|
||||||
|
const pointRadius = normalize(value, axisIndex) * radius;
|
||||||
|
return pointFrom<LocalPoint>(
|
||||||
|
Math.cos(angle) * pointRadius,
|
||||||
|
Math.sin(angle) * pointRadius,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
points.push(pointFrom(points[0][0], points[0][1]));
|
||||||
|
|
||||||
|
return newLinearElement({
|
||||||
|
backgroundColor: "transparent",
|
||||||
|
...commonProps,
|
||||||
|
type: "line",
|
||||||
|
x: centerX,
|
||||||
|
y: centerY,
|
||||||
|
width: radius * 2,
|
||||||
|
height: radius * 2,
|
||||||
|
strokeColor: seriesColors[index],
|
||||||
|
strokeWidth: 2,
|
||||||
|
polygon: true,
|
||||||
|
points,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const seriesLegend = createSeriesLegend(
|
||||||
|
series,
|
||||||
|
seriesColors,
|
||||||
|
centerX,
|
||||||
|
axisLabelBottomY,
|
||||||
|
y + BAR_GAP * 5,
|
||||||
|
backgroundColor,
|
||||||
|
);
|
||||||
|
|
||||||
|
return [
|
||||||
|
...(title ? [title] : []),
|
||||||
|
...axisLabels,
|
||||||
|
...radarGridLines,
|
||||||
|
...spokes,
|
||||||
|
...seriesPolygons,
|
||||||
|
...seriesLegend,
|
||||||
|
];
|
||||||
|
};
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import type { NonDeletedExcalidrawElement } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
export type ChartElements = readonly NonDeletedExcalidrawElement[];
|
||||||
|
|
||||||
|
export interface Spreadsheet {
|
||||||
|
title: string | null;
|
||||||
|
labels: string[] | null;
|
||||||
|
series: SpreadsheetSeries[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SpreadsheetSeries {
|
||||||
|
title: string | null;
|
||||||
|
values: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ParseSpreadsheetResult =
|
||||||
|
| { ok: false; reason: string }
|
||||||
|
| { ok: true; data: Spreadsheet };
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
import type { ChartType } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
import { renderBarChart } from "./charts.bar";
|
||||||
|
import { renderLineChart } from "./charts.line";
|
||||||
|
import {
|
||||||
|
tryParseCells,
|
||||||
|
tryParseNumber,
|
||||||
|
tryParseSpreadsheet,
|
||||||
|
} from "./charts.parse";
|
||||||
|
import { renderRadarChart } from "./charts.radar";
|
||||||
|
|
||||||
|
import type { ChartElements, Spreadsheet } from "./charts.types";
|
||||||
|
|
||||||
|
export {
|
||||||
|
type ParseSpreadsheetResult,
|
||||||
|
type Spreadsheet,
|
||||||
|
type SpreadsheetSeries,
|
||||||
|
type ChartElements,
|
||||||
|
} from "./charts.types";
|
||||||
|
|
||||||
|
export { isSpreadsheetValidForChartType } from "./charts.helpers";
|
||||||
|
export { tryParseCells, tryParseNumber, tryParseSpreadsheet };
|
||||||
|
|
||||||
|
export const renderSpreadsheet = (
|
||||||
|
chartType: ChartType,
|
||||||
|
spreadsheet: Spreadsheet,
|
||||||
|
x: number,
|
||||||
|
y: number,
|
||||||
|
colorSeed?: number,
|
||||||
|
): ChartElements | null => {
|
||||||
|
if (chartType === "line") {
|
||||||
|
return renderLineChart(spreadsheet, x, y, colorSeed);
|
||||||
|
}
|
||||||
|
if (chartType === "radar") {
|
||||||
|
return renderRadarChart(spreadsheet, x, y, colorSeed);
|
||||||
|
}
|
||||||
|
return renderBarChart(spreadsheet, x, y, colorSeed);
|
||||||
|
};
|
||||||
@@ -54,13 +54,7 @@ describe("parseClipboard()", () => {
|
|||||||
}),
|
}),
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
expect(clipboardData.elements).toEqual([
|
expect(clipboardData.elements).toEqual([rect]);
|
||||||
expect.objectContaining({
|
|
||||||
id: rect.id,
|
|
||||||
type: rect.type,
|
|
||||||
schemaState: rect.schemaState,
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse valid excalidraw JSON if inside text/html", async () => {
|
it("should parse valid excalidraw JSON if inside text/html", async () => {
|
||||||
@@ -79,13 +73,7 @@ describe("parseClipboard()", () => {
|
|||||||
}),
|
}),
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
expect(clipboardData.elements).toEqual([
|
expect(clipboardData.elements).toEqual([rect]);
|
||||||
expect.objectContaining({
|
|
||||||
id: rect.id,
|
|
||||||
type: rect.type,
|
|
||||||
schemaState: rect.schemaState,
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
json = serializeAsClipboardJSON({ elements: [rect], files: null });
|
json = serializeAsClipboardJSON({ elements: [rect], files: null });
|
||||||
clipboardData = await parseClipboard(
|
clipboardData = await parseClipboard(
|
||||||
@@ -97,66 +85,10 @@ describe("parseClipboard()", () => {
|
|||||||
}),
|
}),
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
expect(clipboardData.elements).toEqual([
|
expect(clipboardData.elements).toEqual([rect]);
|
||||||
expect.objectContaining({
|
|
||||||
id: rect.id,
|
|
||||||
type: rect.type,
|
|
||||||
schemaState: rect.schemaState,
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should preserve per-element schema on clipboard payload", async () => {
|
|
||||||
const rect = API.createElement({ type: "rectangle" });
|
|
||||||
const clipboardPayload = JSON.parse(
|
|
||||||
serializeAsClipboardJSON({ elements: [rect], files: null }),
|
|
||||||
);
|
|
||||||
|
|
||||||
const clipboardData = await parseClipboard(
|
|
||||||
await parseDataTransferEvent(
|
|
||||||
createPasteEvent({
|
|
||||||
types: {
|
|
||||||
"text/plain": JSON.stringify(clipboardPayload),
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(clipboardData.elements?.[0]).toEqual(
|
|
||||||
expect.objectContaining({
|
|
||||||
id: rect.id,
|
|
||||||
schemaState: rect.schemaState,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should not upcast legacy elements to latest schema on clipboard serialize", async () => {
|
|
||||||
const rect = API.createElement({ type: "rectangle" });
|
|
||||||
const legacyRect = { ...(rect as any) };
|
|
||||||
delete legacyRect.schemaState;
|
|
||||||
|
|
||||||
const clipboardPayload = JSON.parse(
|
|
||||||
serializeAsClipboardJSON({
|
|
||||||
elements: [legacyRect as typeof rect],
|
|
||||||
files: null,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
expect(clipboardPayload.elements[0]).not.toHaveProperty("schemaState");
|
|
||||||
|
|
||||||
const clipboardData = await parseClipboard(
|
|
||||||
await parseDataTransferEvent(
|
|
||||||
createPasteEvent({
|
|
||||||
types: {
|
|
||||||
"text/plain": JSON.stringify(clipboardPayload),
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(clipboardData.elements?.[0]).not.toHaveProperty("schemaState");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should parse <image> `src` urls out of text/html", async () => {
|
it("should parse <image> `src` urls out of text/html", async () => {
|
||||||
let clipboardData;
|
let clipboardData;
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
@@ -223,67 +155,4 @@ describe("parseClipboard()", () => {
|
|||||||
},
|
},
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse spreadsheet from either text/plain and text/html", async () => {
|
|
||||||
let clipboardData;
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
clipboardData = await parseClipboard(
|
|
||||||
await parseDataTransferEvent(
|
|
||||||
createPasteEvent({
|
|
||||||
types: {
|
|
||||||
"text/plain": `a b
|
|
||||||
1 2
|
|
||||||
4 5
|
|
||||||
7 10`,
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
expect(clipboardData.spreadsheet).toEqual({
|
|
||||||
title: "b",
|
|
||||||
labels: ["1", "4", "7"],
|
|
||||||
values: [2, 5, 10],
|
|
||||||
});
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
clipboardData = await parseClipboard(
|
|
||||||
await parseDataTransferEvent(
|
|
||||||
createPasteEvent({
|
|
||||||
types: {
|
|
||||||
"text/html": `a b
|
|
||||||
1 2
|
|
||||||
4 5
|
|
||||||
7 10`,
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
expect(clipboardData.spreadsheet).toEqual({
|
|
||||||
title: "b",
|
|
||||||
labels: ["1", "4", "7"],
|
|
||||||
values: [2, 5, 10],
|
|
||||||
});
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
clipboardData = await parseClipboard(
|
|
||||||
await parseDataTransferEvent(
|
|
||||||
createPasteEvent({
|
|
||||||
types: {
|
|
||||||
"text/html": `<html>
|
|
||||||
<body>
|
|
||||||
<!--StartFragment--><google-sheets-html-origin><style type="text/css"><!--td {border: 1px solid #cccccc;}br {mso-data-placement:same-cell;}--></style><table xmlns="http://www.w3.org/1999/xhtml" cellspacing="0" cellpadding="0" dir="ltr" border="1" style="table-layout:fixed;font-size:10pt;font-family:Arial;width:0px;border-collapse:collapse;border:none"><colgroup><col width="100"/><col width="100"/></colgroup><tbody><tr style="height:21px;"><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;" data-sheets-value="{"1":2,"2":"a"}">a</td><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;" data-sheets-value="{"1":2,"2":"b"}">b</td></tr><tr style="height:21px;"><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":1}">1</td><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":2}">2</td></tr><tr style="height:21px;"><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":4}">4</td><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":5}">5</td></tr><tr style="height:21px;"><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":7}">7</td><td style="overflow:hidden;padding:2px 3px 2px 3px;vertical-align:bottom;text-align:right;" data-sheets-value="{"1":3,"3":10}">10</td></tr></tbody></table><!--EndFragment-->
|
|
||||||
</body>
|
|
||||||
</html>`,
|
|
||||||
"text/plain": `a b
|
|
||||||
1 2
|
|
||||||
4 5
|
|
||||||
7 10`,
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
expect(clipboardData.spreadsheet).toEqual({
|
|
||||||
title: "b",
|
|
||||||
labels: ["1", "4", "7"],
|
|
||||||
values: [2, 5, 10],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -33,12 +33,6 @@ import {
|
|||||||
normalizeFile,
|
normalizeFile,
|
||||||
} from "./data/blob";
|
} from "./data/blob";
|
||||||
|
|
||||||
import { tryParseSpreadsheet, VALID_SPREADSHEET } from "./charts";
|
|
||||||
|
|
||||||
import type { FileSystemHandle } from "./data/filesystem";
|
|
||||||
|
|
||||||
import type { Spreadsheet } from "./charts";
|
|
||||||
|
|
||||||
import type { BinaryFiles } from "./types";
|
import type { BinaryFiles } from "./types";
|
||||||
|
|
||||||
type ElementsClipboard = {
|
type ElementsClipboard = {
|
||||||
@@ -50,7 +44,6 @@ type ElementsClipboard = {
|
|||||||
export type PastedMixedContent = { type: "text" | "imageUrl"; value: string }[];
|
export type PastedMixedContent = { type: "text" | "imageUrl"; value: string }[];
|
||||||
|
|
||||||
export interface ClipboardData {
|
export interface ClipboardData {
|
||||||
spreadsheet?: Spreadsheet;
|
|
||||||
elements?: readonly ExcalidrawElement[];
|
elements?: readonly ExcalidrawElement[];
|
||||||
files?: BinaryFiles;
|
files?: BinaryFiles;
|
||||||
text?: string;
|
text?: string;
|
||||||
@@ -79,10 +72,7 @@ export const probablySupportsClipboardBlob =
|
|||||||
|
|
||||||
const clipboardContainsElements = (
|
const clipboardContainsElements = (
|
||||||
contents: any,
|
contents: any,
|
||||||
): contents is {
|
): contents is { elements: ExcalidrawElement[]; files?: BinaryFiles } => {
|
||||||
elements: ExcalidrawElement[];
|
|
||||||
files?: BinaryFiles;
|
|
||||||
} => {
|
|
||||||
if (
|
if (
|
||||||
[
|
[
|
||||||
EXPORT_DATA_TYPES.excalidraw,
|
EXPORT_DATA_TYPES.excalidraw,
|
||||||
@@ -218,16 +208,6 @@ export const copyToClipboard = async (
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
const parsePotentialSpreadsheet = (
|
|
||||||
text: string,
|
|
||||||
): { spreadsheet: Spreadsheet } | { errorMessage: string } | null => {
|
|
||||||
const result = tryParseSpreadsheet(text);
|
|
||||||
if (result.type === VALID_SPREADSHEET) {
|
|
||||||
return { spreadsheet: result.spreadsheet };
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
};
|
|
||||||
|
|
||||||
/** internal, specific to parsing paste events. Do not reuse. */
|
/** internal, specific to parsing paste events. Do not reuse. */
|
||||||
function parseHTMLTree(el: ChildNode) {
|
function parseHTMLTree(el: ChildNode) {
|
||||||
let result: PastedMixedContent = [];
|
let result: PastedMixedContent = [];
|
||||||
@@ -387,7 +367,7 @@ type AllowedParsedDataTransferItem =
|
|||||||
type: ValueOf<typeof IMAGE_MIME_TYPES>;
|
type: ValueOf<typeof IMAGE_MIME_TYPES>;
|
||||||
kind: "file";
|
kind: "file";
|
||||||
file: File;
|
file: File;
|
||||||
fileHandle: FileSystemHandle | null;
|
fileHandle: FileSystemFileHandle | null;
|
||||||
}
|
}
|
||||||
| { type: ValueOf<typeof STRING_MIME_TYPES>; kind: "string"; value: string };
|
| { type: ValueOf<typeof STRING_MIME_TYPES>; kind: "string"; value: string };
|
||||||
|
|
||||||
@@ -396,7 +376,7 @@ type ParsedDataTransferItem =
|
|||||||
type: string;
|
type: string;
|
||||||
kind: "file";
|
kind: "file";
|
||||||
file: File;
|
file: File;
|
||||||
fileHandle: FileSystemHandle | null;
|
fileHandle: FileSystemFileHandle | null;
|
||||||
}
|
}
|
||||||
| { type: string; kind: "string"; value: string };
|
| { type: string; kind: "string"; value: string };
|
||||||
|
|
||||||
@@ -554,19 +534,6 @@ export const parseClipboard = async (
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
|
||||||
// if system clipboard contains spreadsheet, use it even though it's
|
|
||||||
// technically possible it's staler than in-app clipboard
|
|
||||||
const spreadsheetResult =
|
|
||||||
!isPlainPaste && parsePotentialSpreadsheet(parsedEventData.value);
|
|
||||||
|
|
||||||
if (spreadsheetResult) {
|
|
||||||
return spreadsheetResult;
|
|
||||||
}
|
|
||||||
} catch (error: any) {
|
|
||||||
console.error(error);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const systemClipboardData = JSON.parse(parsedEventData.value);
|
const systemClipboardData = JSON.parse(parsedEventData.value);
|
||||||
const programmaticAPI =
|
const programmaticAPI =
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ import {
|
|||||||
isArrowElement,
|
isArrowElement,
|
||||||
hasStrokeColor,
|
hasStrokeColor,
|
||||||
toolIsArrow,
|
toolIsArrow,
|
||||||
isFrameElement,
|
|
||||||
} from "@excalidraw/element";
|
} from "@excalidraw/element";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
@@ -130,11 +129,8 @@ export const canChangeBackgroundColor = (
|
|||||||
targetElements: ExcalidrawElement[],
|
targetElements: ExcalidrawElement[],
|
||||||
) => {
|
) => {
|
||||||
return (
|
return (
|
||||||
// frame tool shouldn't allow to set background until frame is created
|
|
||||||
hasBackground(appState.activeTool.type) ||
|
hasBackground(appState.activeTool.type) ||
|
||||||
targetElements.some(
|
targetElements.some((element) => hasBackground(element.type))
|
||||||
(element) => hasBackground(element.type) || isFrameElement(element),
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -230,7 +226,7 @@ export const SelectedShapeActions = ({
|
|||||||
{(appState.activeTool.type === "text" ||
|
{(appState.activeTool.type === "text" ||
|
||||||
targetElements.some(isTextElement)) && (
|
targetElements.some(isTextElement)) && (
|
||||||
<>
|
<>
|
||||||
{renderAction("changeFontFamily")}
|
<fieldset>{renderAction("changeFontFamily")}</fieldset>
|
||||||
{renderAction("changeFontSize")}
|
{renderAction("changeFontSize")}
|
||||||
{(appState.activeTool.type === "text" ||
|
{(appState.activeTool.type === "text" ||
|
||||||
suppportsHorizontalAlign(targetElements, elementsMap)) &&
|
suppportsHorizontalAlign(targetElements, elementsMap)) &&
|
||||||
@@ -1085,8 +1081,9 @@ export const ShapesSwitcher = ({
|
|||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
{getToolbarTools(app).map(
|
{getToolbarTools(app).map(
|
||||||
({ value, icon, key, numericKey, fillable }, index) => {
|
({ value, icon, key, numericKey, fillable, toolbar }) => {
|
||||||
if (
|
if (
|
||||||
|
toolbar === false ||
|
||||||
UIOptions.tools?.[
|
UIOptions.tools?.[
|
||||||
value as Extract<
|
value as Extract<
|
||||||
typeof value,
|
typeof value,
|
||||||
@@ -1103,6 +1100,9 @@ export const ShapesSwitcher = ({
|
|||||||
const shortcut = letter
|
const shortcut = letter
|
||||||
? `${letter} ${t("helpDialog.or")} ${numericKey}`
|
? `${letter} ${t("helpDialog.or")} ${numericKey}`
|
||||||
: `${numericKey}`;
|
: `${numericKey}`;
|
||||||
|
const keybindingLabel =
|
||||||
|
value === "hand" ? undefined : numericKey || letter;
|
||||||
|
|
||||||
// when in compact styles panel mode (tablet)
|
// when in compact styles panel mode (tablet)
|
||||||
// use a ToolPopover for selection/lasso toggle as well
|
// use a ToolPopover for selection/lasso toggle as well
|
||||||
if (
|
if (
|
||||||
@@ -1147,7 +1147,7 @@ export const ShapesSwitcher = ({
|
|||||||
checked={activeTool.type === value}
|
checked={activeTool.type === value}
|
||||||
name="editor-current-shape"
|
name="editor-current-shape"
|
||||||
title={`${capitalizeString(label)} — ${shortcut}`}
|
title={`${capitalizeString(label)} — ${shortcut}`}
|
||||||
keyBindingLabel={numericKey || letter}
|
keyBindingLabel={keybindingLabel}
|
||||||
aria-label={capitalizeString(label)}
|
aria-label={capitalizeString(label)}
|
||||||
aria-keyshortcuts={shortcut}
|
aria-keyshortcuts={shortcut}
|
||||||
data-testid={`toolbar-${value}`}
|
data-testid={`toolbar-${value}`}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,208 @@
|
|||||||
|
import type { AppState, UnsubscribeCallback } from "../types";
|
||||||
|
|
||||||
|
type StateChangeSelector =
|
||||||
|
| keyof AppState
|
||||||
|
| (keyof AppState)[]
|
||||||
|
| ((appState: AppState) => unknown);
|
||||||
|
|
||||||
|
type StateChangePredicateOptions = {
|
||||||
|
predicate: (appState: AppState) => boolean;
|
||||||
|
callback?: (appState: AppState) => void;
|
||||||
|
once?: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
type StateChangeArg = StateChangeSelector | StateChangePredicateOptions;
|
||||||
|
|
||||||
|
type StateChangeListener = {
|
||||||
|
predicate: (appState: AppState, prevState: AppState) => boolean;
|
||||||
|
getValue: (appState: AppState) => unknown;
|
||||||
|
callback: (value: any, appState: AppState) => void;
|
||||||
|
once: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
type NormalizedStateChange = {
|
||||||
|
predicate: StateChangeListener["predicate"];
|
||||||
|
getValue: StateChangeListener["getValue"];
|
||||||
|
callback?: StateChangeListener["callback"];
|
||||||
|
once: boolean;
|
||||||
|
matchesImmediately: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type OnStateChange = {
|
||||||
|
<K extends keyof AppState>(
|
||||||
|
prop: K,
|
||||||
|
callback: (value: AppState[K], appState: AppState) => void,
|
||||||
|
opts?: { once: boolean },
|
||||||
|
): UnsubscribeCallback;
|
||||||
|
<K extends keyof AppState>(prop: K): Promise<AppState[K]>;
|
||||||
|
(
|
||||||
|
prop: (keyof AppState)[],
|
||||||
|
callback: (appState: AppState, appState2: AppState) => void,
|
||||||
|
opts?: { once: boolean },
|
||||||
|
): UnsubscribeCallback;
|
||||||
|
(prop: (keyof AppState)[]): Promise<AppState>;
|
||||||
|
<T>(
|
||||||
|
prop: (appState: AppState) => T,
|
||||||
|
callback: (value: T, appState: AppState) => void,
|
||||||
|
opts?: { once: boolean },
|
||||||
|
): UnsubscribeCallback;
|
||||||
|
<T>(prop: (appState: AppState) => T): Promise<T>;
|
||||||
|
(opts: {
|
||||||
|
predicate: (appState: AppState) => boolean;
|
||||||
|
callback: (appState: AppState) => void;
|
||||||
|
once?: boolean;
|
||||||
|
}): UnsubscribeCallback;
|
||||||
|
(opts: { predicate: (appState: AppState) => boolean }): Promise<AppState>;
|
||||||
|
(
|
||||||
|
selector: StateChangeSelector,
|
||||||
|
callback: (value: any, appState: AppState) => void,
|
||||||
|
): any;
|
||||||
|
};
|
||||||
|
|
||||||
|
export class AppStateObserver {
|
||||||
|
private listeners: StateChangeListener[] = [];
|
||||||
|
|
||||||
|
constructor(private readonly getState: () => AppState) {}
|
||||||
|
|
||||||
|
private isStateChangePredicateOptions(
|
||||||
|
propOrOpts: StateChangeArg,
|
||||||
|
): propOrOpts is StateChangePredicateOptions {
|
||||||
|
return (
|
||||||
|
typeof propOrOpts === "object" &&
|
||||||
|
!Array.isArray(propOrOpts) &&
|
||||||
|
"predicate" in propOrOpts
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private subscribe(listener: StateChangeListener): UnsubscribeCallback {
|
||||||
|
this.listeners.push(listener);
|
||||||
|
return () => {
|
||||||
|
this.listeners = this.listeners.filter(
|
||||||
|
(existingListener) => existingListener !== listener,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private normalize(
|
||||||
|
propOrOpts: StateChangeArg,
|
||||||
|
callback?: (value: any, appState: AppState) => void,
|
||||||
|
opts?: { once: boolean },
|
||||||
|
): NormalizedStateChange {
|
||||||
|
let predicate: StateChangeListener["predicate"];
|
||||||
|
let getValue: StateChangeListener["getValue"];
|
||||||
|
let normalizedCallback = callback;
|
||||||
|
let once = opts?.once ?? false;
|
||||||
|
let matchesImmediately = false;
|
||||||
|
|
||||||
|
if (this.isStateChangePredicateOptions(propOrOpts)) {
|
||||||
|
const {
|
||||||
|
predicate: predicateFn,
|
||||||
|
callback: callbackFromOpts,
|
||||||
|
once: onceFromOpts,
|
||||||
|
} = propOrOpts;
|
||||||
|
|
||||||
|
predicate = predicateFn;
|
||||||
|
getValue = (appState: AppState) => appState;
|
||||||
|
normalizedCallback = callbackFromOpts
|
||||||
|
? (_value: AppState, appState: AppState) => callbackFromOpts(appState)
|
||||||
|
: undefined;
|
||||||
|
once = onceFromOpts ?? false;
|
||||||
|
matchesImmediately = predicateFn(this.getState());
|
||||||
|
} else if (typeof propOrOpts === "function") {
|
||||||
|
const selector = propOrOpts;
|
||||||
|
predicate = (appState: AppState, prevState: AppState) =>
|
||||||
|
selector(appState) !== selector(prevState);
|
||||||
|
getValue = (appState: AppState) => selector(appState);
|
||||||
|
} else if (Array.isArray(propOrOpts)) {
|
||||||
|
const keys = propOrOpts;
|
||||||
|
predicate = (appState: AppState, prevState: AppState) =>
|
||||||
|
keys.some((key) => appState[key] !== prevState[key]);
|
||||||
|
getValue = (appState: AppState) => appState;
|
||||||
|
} else {
|
||||||
|
const key = propOrOpts;
|
||||||
|
predicate = (appState: AppState, prevState: AppState) =>
|
||||||
|
appState[key] !== prevState[key];
|
||||||
|
getValue = (appState: AppState) => appState[key];
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
predicate,
|
||||||
|
getValue,
|
||||||
|
callback: normalizedCallback,
|
||||||
|
once,
|
||||||
|
matchesImmediately,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
public onStateChange: OnStateChange = ((
|
||||||
|
propOrOpts: StateChangeArg,
|
||||||
|
callback?: any,
|
||||||
|
opts?: { once: boolean },
|
||||||
|
) => {
|
||||||
|
const {
|
||||||
|
predicate,
|
||||||
|
getValue,
|
||||||
|
callback: stateChangeCallback,
|
||||||
|
once,
|
||||||
|
matchesImmediately,
|
||||||
|
} = this.normalize(propOrOpts, callback, opts);
|
||||||
|
|
||||||
|
if (stateChangeCallback) {
|
||||||
|
if (matchesImmediately) {
|
||||||
|
queueMicrotask(() => {
|
||||||
|
const state = this.getState();
|
||||||
|
stateChangeCallback(getValue(state), state);
|
||||||
|
});
|
||||||
|
if (once) {
|
||||||
|
return () => {};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.subscribe({
|
||||||
|
predicate,
|
||||||
|
getValue,
|
||||||
|
callback: stateChangeCallback,
|
||||||
|
once,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (matchesImmediately) {
|
||||||
|
return Promise.resolve(getValue(this.getState()));
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Promise<any>((resolve) => {
|
||||||
|
this.subscribe({
|
||||||
|
predicate,
|
||||||
|
getValue,
|
||||||
|
callback: (value) => resolve(value),
|
||||||
|
once: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}) as OnStateChange;
|
||||||
|
|
||||||
|
public flush(prevState: AppState) {
|
||||||
|
if (!this.listeners.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const state = this.getState();
|
||||||
|
const listenersToKeep: StateChangeListener[] = [];
|
||||||
|
|
||||||
|
for (const listener of this.listeners) {
|
||||||
|
if (listener.predicate(state, prevState)) {
|
||||||
|
listener.callback(listener.getValue(state), state);
|
||||||
|
if (!listener.once) {
|
||||||
|
listenersToKeep.push(listener);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
listenersToKeep.push(listener);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.listeners = listenersToKeep;
|
||||||
|
}
|
||||||
|
|
||||||
|
public clear() {
|
||||||
|
this.listeners = [];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,12 +10,11 @@ import {
|
|||||||
isWritableElement,
|
isWritableElement,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
import { actionToggleShapeSwitch } from "@excalidraw/excalidraw/actions/actionToggleShapeSwitch";
|
|
||||||
|
|
||||||
import { getShortcutKey } from "@excalidraw/excalidraw/shortcut";
|
|
||||||
|
|
||||||
import type { MarkRequired } from "@excalidraw/common/utility-types";
|
import type { MarkRequired } from "@excalidraw/common/utility-types";
|
||||||
|
|
||||||
|
import { actionToggleShapeSwitch } from "../../actions/actionToggleShapeSwitch";
|
||||||
|
import { getShortcutKey } from "../../shortcut";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
actionClearCanvas,
|
actionClearCanvas,
|
||||||
actionLink,
|
actionLink,
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ export type CommandPaletteItem = {
|
|||||||
category: string;
|
category: string;
|
||||||
order?: number;
|
order?: number;
|
||||||
predicate?: boolean | Action["predicate"];
|
predicate?: boolean | Action["predicate"];
|
||||||
shortcut?: string;
|
shortcut?: string | null;
|
||||||
/** if false, command will not show while in view mode */
|
/** if false, command will not show while in view mode */
|
||||||
viewMode?: boolean;
|
viewMode?: boolean;
|
||||||
perform: (data: {
|
perform: (data: {
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
import { type ReactNode, useEffect, useMemo, useRef, useState } from "react";
|
import { type ReactNode, useEffect, useMemo, useRef, useState } from "react";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
|
bumpVersion,
|
||||||
getLinearElementSubType,
|
getLinearElementSubType,
|
||||||
|
mutateElement,
|
||||||
updateElbowArrowPoints,
|
updateElbowArrowPoints,
|
||||||
} from "@excalidraw/element";
|
} from "@excalidraw/element";
|
||||||
|
|
||||||
@@ -37,6 +39,8 @@ import {
|
|||||||
isProdEnv,
|
isProdEnv,
|
||||||
mapFind,
|
mapFind,
|
||||||
reduceToCommonValue,
|
reduceToCommonValue,
|
||||||
|
ROUNDNESS,
|
||||||
|
sceneCoordsToViewportCoords,
|
||||||
updateActiveTool,
|
updateActiveTool,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
@@ -71,12 +75,6 @@ import type {
|
|||||||
|
|
||||||
import type { Scene } from "@excalidraw/element";
|
import type { Scene } from "@excalidraw/element";
|
||||||
|
|
||||||
import {
|
|
||||||
bumpVersion,
|
|
||||||
mutateElement,
|
|
||||||
ROUNDNESS,
|
|
||||||
sceneCoordsToViewportCoords,
|
|
||||||
} from "..";
|
|
||||||
import { trackEvent } from "../analytics";
|
import { trackEvent } from "../analytics";
|
||||||
import { atom } from "../editor-jotai";
|
import { atom } from "../editor-jotai";
|
||||||
|
|
||||||
|
|||||||
@@ -59,6 +59,7 @@ type ImageExportModalProps = {
|
|||||||
actionManager: ActionManager;
|
actionManager: ActionManager;
|
||||||
onExportImage: AppClassProperties["onExportImage"];
|
onExportImage: AppClassProperties["onExportImage"];
|
||||||
name: string;
|
name: string;
|
||||||
|
exportWithDarkMode: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
const ImageExportModal = ({
|
const ImageExportModal = ({
|
||||||
@@ -68,6 +69,7 @@ const ImageExportModal = ({
|
|||||||
actionManager,
|
actionManager,
|
||||||
onExportImage,
|
onExportImage,
|
||||||
name,
|
name,
|
||||||
|
exportWithDarkMode,
|
||||||
}: ImageExportModalProps) => {
|
}: ImageExportModalProps) => {
|
||||||
const hasSelection = isSomeElementSelected(
|
const hasSelection = isSomeElementSelected(
|
||||||
elementsSnapshot,
|
elementsSnapshot,
|
||||||
@@ -79,15 +81,13 @@ const ImageExportModal = ({
|
|||||||
const [exportWithBackground, setExportWithBackground] = useState(
|
const [exportWithBackground, setExportWithBackground] = useState(
|
||||||
appStateSnapshot.exportBackground,
|
appStateSnapshot.exportBackground,
|
||||||
);
|
);
|
||||||
const [exportDarkMode, setExportDarkMode] = useState(
|
|
||||||
appStateSnapshot.exportWithDarkMode,
|
|
||||||
);
|
|
||||||
const [embedScene, setEmbedScene] = useState(
|
const [embedScene, setEmbedScene] = useState(
|
||||||
appStateSnapshot.exportEmbedScene,
|
appStateSnapshot.exportEmbedScene,
|
||||||
);
|
);
|
||||||
const [exportScale, setExportScale] = useState(appStateSnapshot.exportScale);
|
const [exportScale, setExportScale] = useState(appStateSnapshot.exportScale);
|
||||||
|
|
||||||
const previewRef = useRef<HTMLDivElement>(null);
|
const previewRef = useRef<HTMLDivElement>(null);
|
||||||
|
const previewRenderRequestIdRef = useRef(0);
|
||||||
const [renderError, setRenderError] = useState<Error | null>(null);
|
const [renderError, setRenderError] = useState<Error | null>(null);
|
||||||
|
|
||||||
const { onCopy, copyStatus, resetCopyStatus } = useCopyStatus();
|
const { onCopy, copyStatus, resetCopyStatus } = useCopyStatus();
|
||||||
@@ -99,7 +99,7 @@ const ImageExportModal = ({
|
|||||||
}, [
|
}, [
|
||||||
projectName,
|
projectName,
|
||||||
exportWithBackground,
|
exportWithBackground,
|
||||||
exportDarkMode,
|
exportWithDarkMode,
|
||||||
exportScale,
|
exportScale,
|
||||||
embedScene,
|
embedScene,
|
||||||
resetCopyStatus,
|
resetCopyStatus,
|
||||||
@@ -122,13 +122,18 @@ const ImageExportModal = ({
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const requestId = ++previewRenderRequestIdRef.current;
|
||||||
|
const isStaleRequest = () => {
|
||||||
|
return requestId !== previewRenderRequestIdRef.current;
|
||||||
|
};
|
||||||
|
|
||||||
exportToCanvas({
|
exportToCanvas({
|
||||||
elements: exportedElements,
|
elements: exportedElements,
|
||||||
appState: {
|
appState: {
|
||||||
...appStateSnapshot,
|
...appStateSnapshot,
|
||||||
name: projectName,
|
name: projectName,
|
||||||
exportBackground: exportWithBackground,
|
exportBackground: exportWithBackground,
|
||||||
exportWithDarkMode: exportDarkMode,
|
exportWithDarkMode,
|
||||||
exportScale,
|
exportScale,
|
||||||
exportEmbedScene: embedScene,
|
exportEmbedScene: embedScene,
|
||||||
},
|
},
|
||||||
@@ -137,25 +142,41 @@ const ImageExportModal = ({
|
|||||||
maxWidthOrHeight: Math.max(maxWidth, maxHeight),
|
maxWidthOrHeight: Math.max(maxWidth, maxHeight),
|
||||||
exportingFrame,
|
exportingFrame,
|
||||||
})
|
})
|
||||||
.then((canvas) => {
|
.then(async (canvas) => {
|
||||||
|
if (isStaleRequest()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If converting to blob fails, there's some problem that will likely
|
||||||
|
// prevent preview and export (e.g. canvas too big).
|
||||||
|
try {
|
||||||
|
await canvasToBlob(canvas);
|
||||||
|
} catch (error: any) {
|
||||||
|
if (error.name === "CANVAS_POSSIBLY_TOO_BIG") {
|
||||||
|
throw new Error(t("canvasError.canvasTooBig"));
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isStaleRequest()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
setRenderError(null);
|
setRenderError(null);
|
||||||
// if converting to blob fails, there's some problem that will
|
previewNode.replaceChildren(canvas);
|
||||||
// likely prevent preview and export (e.g. canvas too big)
|
|
||||||
return canvasToBlob(canvas)
|
|
||||||
.then(() => {
|
|
||||||
previewNode.replaceChildren(canvas);
|
|
||||||
})
|
|
||||||
.catch((e) => {
|
|
||||||
if (e.name === "CANVAS_POSSIBLY_TOO_BIG") {
|
|
||||||
throw new Error(t("canvasError.canvasTooBig"));
|
|
||||||
}
|
|
||||||
throw e;
|
|
||||||
});
|
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
|
if (isStaleRequest()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
console.error(error);
|
console.error(error);
|
||||||
setRenderError(error);
|
setRenderError(error);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
previewRenderRequestIdRef.current += 1;
|
||||||
|
};
|
||||||
}, [
|
}, [
|
||||||
appStateSnapshot,
|
appStateSnapshot,
|
||||||
files,
|
files,
|
||||||
@@ -163,7 +184,7 @@ const ImageExportModal = ({
|
|||||||
exportingFrame,
|
exportingFrame,
|
||||||
projectName,
|
projectName,
|
||||||
exportWithBackground,
|
exportWithBackground,
|
||||||
exportDarkMode,
|
exportWithDarkMode,
|
||||||
exportScale,
|
exportScale,
|
||||||
embedScene,
|
embedScene,
|
||||||
]);
|
]);
|
||||||
@@ -233,9 +254,8 @@ const ImageExportModal = ({
|
|||||||
>
|
>
|
||||||
<Switch
|
<Switch
|
||||||
name="exportDarkModeSwitch"
|
name="exportDarkModeSwitch"
|
||||||
checked={exportDarkMode}
|
checked={exportWithDarkMode}
|
||||||
onChange={(checked) => {
|
onChange={(checked) => {
|
||||||
setExportDarkMode(checked);
|
|
||||||
actionManager.executeAction(
|
actionManager.executeAction(
|
||||||
actionExportWithDarkMode,
|
actionExportWithDarkMode,
|
||||||
"ui",
|
"ui",
|
||||||
@@ -399,6 +419,7 @@ export const ImageExportDialog = ({
|
|||||||
actionManager={actionManager}
|
actionManager={actionManager}
|
||||||
onExportImage={onExportImage}
|
onExportImage={onExportImage}
|
||||||
name={name}
|
name={name}
|
||||||
|
exportWithDarkMode={appState.exportWithDarkMode}
|
||||||
/>
|
/>
|
||||||
</Dialog>
|
</Dialog>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ import type { NonDeletedExcalidrawElement } from "@excalidraw/element/types";
|
|||||||
|
|
||||||
import { actionToggleStats } from "../actions";
|
import { actionToggleStats } from "../actions";
|
||||||
import { trackEvent } from "../analytics";
|
import { trackEvent } from "../analytics";
|
||||||
import { isHandToolActive } from "../appState";
|
|
||||||
import { TunnelsContext, useInitializeTunnels } from "../context/tunnels";
|
import { TunnelsContext, useInitializeTunnels } from "../context/tunnels";
|
||||||
import { UIAppStateContext } from "../context/ui-appState";
|
import { UIAppStateContext } from "../context/ui-appState";
|
||||||
import { useAtom, useAtomValue } from "../editor-jotai";
|
import { useAtom, useAtomValue } from "../editor-jotai";
|
||||||
@@ -55,13 +54,13 @@ import ElementLinkDialog from "./ElementLinkDialog";
|
|||||||
import { ErrorDialog } from "./ErrorDialog";
|
import { ErrorDialog } from "./ErrorDialog";
|
||||||
import { EyeDropper, activeEyeDropperAtom } from "./EyeDropper";
|
import { EyeDropper, activeEyeDropperAtom } from "./EyeDropper";
|
||||||
import { FixedSideContainer } from "./FixedSideContainer";
|
import { FixedSideContainer } from "./FixedSideContainer";
|
||||||
import { HandButton } from "./HandButton";
|
|
||||||
import { HelpDialog } from "./HelpDialog";
|
import { HelpDialog } from "./HelpDialog";
|
||||||
import { HintViewer } from "./HintViewer";
|
import { HintViewer } from "./HintViewer";
|
||||||
import { ImageExportDialog } from "./ImageExportDialog";
|
import { ImageExportDialog } from "./ImageExportDialog";
|
||||||
import { Island } from "./Island";
|
import { Island } from "./Island";
|
||||||
import { JSONExportDialog } from "./JSONExportDialog";
|
import { JSONExportDialog } from "./JSONExportDialog";
|
||||||
import { LaserPointerButton } from "./LaserPointerButton";
|
import { LaserPointerButton } from "./LaserPointerButton";
|
||||||
|
import { Toast } from "./Toast";
|
||||||
|
|
||||||
import "./LayerUI.scss";
|
import "./LayerUI.scss";
|
||||||
import "./Toolbar.scss";
|
import "./Toolbar.scss";
|
||||||
@@ -359,13 +358,6 @@ const LayerUI = ({
|
|||||||
|
|
||||||
<div className="App-toolbar__divider" />
|
<div className="App-toolbar__divider" />
|
||||||
|
|
||||||
<HandButton
|
|
||||||
checked={isHandToolActive(appState)}
|
|
||||||
onChange={() => onHandToolToggle()}
|
|
||||||
title={t("toolBar.hand")}
|
|
||||||
isMobile
|
|
||||||
/>
|
|
||||||
|
|
||||||
<ShapesSwitcher
|
<ShapesSwitcher
|
||||||
setAppState={setAppState}
|
setAppState={setAppState}
|
||||||
activeTool={appState.activeTool}
|
activeTool={appState.activeTool}
|
||||||
@@ -565,13 +557,13 @@ const LayerUI = ({
|
|||||||
<tunnels.OverwriteConfirmDialogTunnel.Out />
|
<tunnels.OverwriteConfirmDialogTunnel.Out />
|
||||||
{renderImageExportDialog()}
|
{renderImageExportDialog()}
|
||||||
{renderJSONExportDialog()}
|
{renderJSONExportDialog()}
|
||||||
{appState.pasteDialog.shown && (
|
{appState.openDialog?.name === "charts" && (
|
||||||
<PasteChartDialog
|
<PasteChartDialog
|
||||||
setAppState={setAppState}
|
data={appState.openDialog.data}
|
||||||
appState={appState}
|
rawText={appState.openDialog.rawText}
|
||||||
onClose={() =>
|
onClose={() =>
|
||||||
setAppState({
|
setAppState({
|
||||||
pasteDialog: { shown: false, data: null },
|
openDialog: null,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
@@ -614,18 +606,30 @@ const LayerUI = ({
|
|||||||
showExitZenModeBtn={showExitZenModeBtn}
|
showExitZenModeBtn={showExitZenModeBtn}
|
||||||
renderWelcomeScreen={renderWelcomeScreen}
|
renderWelcomeScreen={renderWelcomeScreen}
|
||||||
/>
|
/>
|
||||||
{appState.scrolledOutside && (
|
{(appState.toast || appState.scrolledOutside) && (
|
||||||
<button
|
<div className="floating-status-stack">
|
||||||
type="button"
|
{appState.toast && (
|
||||||
className="scroll-back-to-content"
|
<Toast
|
||||||
onClick={() => {
|
message={appState.toast.message}
|
||||||
setAppState((appState) => ({
|
onClose={() => setAppState({ toast: null })}
|
||||||
...calculateScrollCenter(elements, appState),
|
duration={appState.toast.duration}
|
||||||
}));
|
closable={appState.toast.closable}
|
||||||
}}
|
/>
|
||||||
>
|
)}
|
||||||
{t("buttons.scrollBackToContent")}
|
{!appState.toast && appState.scrolledOutside && (
|
||||||
</button>
|
<button
|
||||||
|
type="button"
|
||||||
|
className="scroll-back-to-content"
|
||||||
|
onClick={() => {
|
||||||
|
setAppState((appState) => ({
|
||||||
|
...calculateScrollCenter(elements, appState),
|
||||||
|
}));
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{t("buttons.scrollBackToContent")}
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
)}
|
)}
|
||||||
</div>
|
</div>
|
||||||
{renderSidebars()}
|
{renderSidebars()}
|
||||||
|
|||||||
@@ -472,9 +472,9 @@ export const MobileToolBar = ({
|
|||||||
onSelect={() => app.onMagicframeToolSelect()}
|
onSelect={() => app.onMagicframeToolSelect()}
|
||||||
icon={MagicIcon}
|
icon={MagicIcon}
|
||||||
data-testid="toolbar-magicframe"
|
data-testid="toolbar-magicframe"
|
||||||
|
badge={<DropdownMenu.Item.Badge>AI</DropdownMenu.Item.Badge>}
|
||||||
>
|
>
|
||||||
{t("toolBar.magicframe")}
|
{t("toolBar.magicframe")}
|
||||||
<DropdownMenu.Item.Badge>AI</DropdownMenu.Item.Badge>
|
|
||||||
</DropdownMenu.Item>
|
</DropdownMenu.Item>
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
|
|||||||
@@ -2,6 +2,40 @@
|
|||||||
|
|
||||||
.excalidraw {
|
.excalidraw {
|
||||||
.PasteChartDialog {
|
.PasteChartDialog {
|
||||||
|
.PasteChartDialog__title {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.PasteChartDialog__titleText {
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.PasteChartDialog__reshuffleBtn {
|
||||||
|
margin-left: auto;
|
||||||
|
flex: 0 0 auto;
|
||||||
|
width: 1rem;
|
||||||
|
height: 1rem;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
border-radius: 4px;
|
||||||
|
cursor: pointer;
|
||||||
|
color: var(--text-primary-color);
|
||||||
|
transition: transform 120ms ease, background-color 120ms ease,
|
||||||
|
color 120ms ease;
|
||||||
|
user-select: none;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
color: $color-blue-6;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:active {
|
||||||
|
transform: scale(0.94);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@include isMobile {
|
@include isMobile {
|
||||||
.Island {
|
.Island {
|
||||||
display: flex;
|
display: flex;
|
||||||
@@ -11,35 +45,61 @@
|
|||||||
.container {
|
.container {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
justify-content: space-around;
|
justify-content: center;
|
||||||
flex-wrap: wrap;
|
flex-wrap: wrap;
|
||||||
|
gap: 1rem;
|
||||||
@include isMobile {
|
@include isMobile {
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
justify-content: center;
|
justify-content: center;
|
||||||
|
align-items: stretch;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
.ChartPreview {
|
.ChartPreview {
|
||||||
margin: 8px;
|
width: 260px;
|
||||||
text-align: center;
|
min-height: 190px;
|
||||||
width: 192px;
|
border-radius: 8px;
|
||||||
height: 128px;
|
padding: 10px;
|
||||||
border-radius: 2px;
|
|
||||||
padding: 1px;
|
|
||||||
border: 1px solid $color-gray-4;
|
border: 1px solid $color-gray-4;
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
flex-direction: column;
|
||||||
justify-content: center;
|
align-items: stretch;
|
||||||
|
justify-content: flex-start;
|
||||||
|
gap: 10px;
|
||||||
background: transparent;
|
background: transparent;
|
||||||
div {
|
.ChartPreview__canvas {
|
||||||
display: inline-block;
|
display: flex;
|
||||||
|
flex: 1;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
.ChartPreview__label {
|
||||||
|
font-size: 0.875rem;
|
||||||
|
font-weight: 600;
|
||||||
|
line-height: 1;
|
||||||
|
text-align: center;
|
||||||
|
color: var(--text-primary-color);
|
||||||
}
|
}
|
||||||
svg {
|
svg {
|
||||||
max-height: 120px;
|
max-height: 144px;
|
||||||
max-width: 186px;
|
max-width: 100%;
|
||||||
}
|
}
|
||||||
&:hover {
|
&:hover {
|
||||||
padding: 0;
|
border-color: $color-blue-5;
|
||||||
border: 2px solid $color-blue-5;
|
}
|
||||||
|
&:active {
|
||||||
|
border-color: $color-blue-5;
|
||||||
|
box-shadow: 0 0 0 1px $color-blue-5;
|
||||||
|
transform: scale(0.98);
|
||||||
|
}
|
||||||
|
&:focus-visible {
|
||||||
|
border-color: $color-blue-5;
|
||||||
|
box-shadow: 0 0 0 1px $color-blue-5;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include isMobile {
|
||||||
|
width: 100%;
|
||||||
|
min-height: 200px;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,35 +1,57 @@
|
|||||||
import React, { useLayoutEffect, useRef, useState } from "react";
|
import React, { useLayoutEffect, useRef, useState } from "react";
|
||||||
|
|
||||||
|
import { newTextElement } from "@excalidraw/element";
|
||||||
|
|
||||||
import type { ChartType } from "@excalidraw/element/types";
|
import type { ChartType } from "@excalidraw/element/types";
|
||||||
|
|
||||||
import { trackEvent } from "../analytics";
|
import { trackEvent } from "../analytics";
|
||||||
import { renderSpreadsheet } from "../charts";
|
import { isSpreadsheetValidForChartType, renderSpreadsheet } from "../charts";
|
||||||
import { t } from "../i18n";
|
import { t } from "../i18n";
|
||||||
import { exportToSvg } from "../scene/export";
|
import { exportToSvg } from "../scene/export";
|
||||||
|
|
||||||
|
import { useUIAppState } from "../context/ui-appState";
|
||||||
|
|
||||||
import { useApp } from "./App";
|
import { useApp } from "./App";
|
||||||
import { Dialog } from "./Dialog";
|
import { Dialog } from "./Dialog";
|
||||||
|
|
||||||
import "./PasteChartDialog.scss";
|
import "./PasteChartDialog.scss";
|
||||||
|
|
||||||
|
import { bucketFillIcon } from "./icons";
|
||||||
|
|
||||||
import type { ChartElements, Spreadsheet } from "../charts";
|
import type { ChartElements, Spreadsheet } from "../charts";
|
||||||
import type { UIAppState } from "../types";
|
|
||||||
|
type OnPlainTextPaste = (rawText: string) => void;
|
||||||
|
|
||||||
type OnInsertChart = (chartType: ChartType, elements: ChartElements) => void;
|
type OnInsertChart = (chartType: ChartType, elements: ChartElements) => void;
|
||||||
|
|
||||||
|
const getChartTypeLabel = (chartType: ChartType) => {
|
||||||
|
switch (chartType) {
|
||||||
|
case "bar":
|
||||||
|
return t("labels.chartType_bar");
|
||||||
|
case "line":
|
||||||
|
return t("labels.chartType_line");
|
||||||
|
case "radar":
|
||||||
|
return t("labels.chartType_radar");
|
||||||
|
default:
|
||||||
|
return chartType;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
const ChartPreviewBtn = (props: {
|
const ChartPreviewBtn = (props: {
|
||||||
spreadsheet: Spreadsheet | null;
|
spreadsheet: Spreadsheet | null;
|
||||||
chartType: ChartType;
|
chartType: ChartType;
|
||||||
selected: boolean;
|
colorSeed: number;
|
||||||
onClick: OnInsertChart;
|
onClick: OnInsertChart;
|
||||||
}) => {
|
}) => {
|
||||||
const previewRef = useRef<HTMLDivElement | null>(null);
|
const previewRef = useRef<HTMLDivElement | null>(null);
|
||||||
const [chartElements, setChartElements] = useState<ChartElements | null>(
|
const [chartElements, setChartElements] = useState<ChartElements | null>(
|
||||||
null,
|
null,
|
||||||
);
|
);
|
||||||
|
const { theme } = useUIAppState();
|
||||||
|
|
||||||
useLayoutEffect(() => {
|
useLayoutEffect(() => {
|
||||||
if (!props.spreadsheet) {
|
if (!props.spreadsheet) {
|
||||||
|
setChartElements(null);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -38,7 +60,13 @@ const ChartPreviewBtn = (props: {
|
|||||||
props.spreadsheet,
|
props.spreadsheet,
|
||||||
0,
|
0,
|
||||||
0,
|
0,
|
||||||
|
props.colorSeed,
|
||||||
);
|
);
|
||||||
|
if (!elements) {
|
||||||
|
setChartElements(null);
|
||||||
|
previewRef.current?.replaceChildren();
|
||||||
|
return;
|
||||||
|
}
|
||||||
setChartElements(elements);
|
setChartElements(elements);
|
||||||
let svg: SVGSVGElement;
|
let svg: SVGSVGElement;
|
||||||
const previewNode = previewRef.current!;
|
const previewNode = previewRef.current!;
|
||||||
@@ -49,6 +77,7 @@ const ChartPreviewBtn = (props: {
|
|||||||
{
|
{
|
||||||
exportBackground: false,
|
exportBackground: false,
|
||||||
viewBackgroundColor: "#fff",
|
viewBackgroundColor: "#fff",
|
||||||
|
exportWithDarkMode: theme === "dark",
|
||||||
},
|
},
|
||||||
null, // files
|
null, // files
|
||||||
{
|
{
|
||||||
@@ -58,42 +87,108 @@ const ChartPreviewBtn = (props: {
|
|||||||
svg.querySelector(".style-fonts")?.remove();
|
svg.querySelector(".style-fonts")?.remove();
|
||||||
previewNode.replaceChildren();
|
previewNode.replaceChildren();
|
||||||
previewNode.appendChild(svg);
|
previewNode.appendChild(svg);
|
||||||
|
|
||||||
if (props.selected) {
|
|
||||||
(previewNode.parentNode as HTMLDivElement).focus();
|
|
||||||
}
|
|
||||||
})();
|
})();
|
||||||
|
|
||||||
return () => {
|
return () => {
|
||||||
previewNode.replaceChildren();
|
previewNode.replaceChildren();
|
||||||
};
|
};
|
||||||
}, [props.spreadsheet, props.chartType, props.selected]);
|
}, [props.spreadsheet, props.chartType, props.colorSeed, theme]);
|
||||||
|
|
||||||
|
const chartTypeLabel = getChartTypeLabel(props.chartType);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
className="ChartPreview"
|
className="ChartPreview"
|
||||||
|
aria-label={chartTypeLabel}
|
||||||
onClick={() => {
|
onClick={() => {
|
||||||
if (chartElements) {
|
if (chartElements) {
|
||||||
props.onClick(props.chartType, chartElements);
|
props.onClick(props.chartType, chartElements);
|
||||||
}
|
}
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<div ref={previewRef} />
|
<div className="ChartPreview__canvas" ref={previewRef} />
|
||||||
|
<div className="ChartPreview__label">{chartTypeLabel}</div>
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const PlainTextPreviewBtn = (props: {
|
||||||
|
rawText: string;
|
||||||
|
onClick: OnPlainTextPaste;
|
||||||
|
}) => {
|
||||||
|
const previewRef = useRef<HTMLDivElement | null>(null);
|
||||||
|
const { theme } = useUIAppState();
|
||||||
|
|
||||||
|
useLayoutEffect(() => {
|
||||||
|
if (!props.rawText) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const textElement = newTextElement({
|
||||||
|
text: props.rawText,
|
||||||
|
x: 0,
|
||||||
|
y: 0,
|
||||||
|
});
|
||||||
|
|
||||||
|
const previewNode = previewRef.current!;
|
||||||
|
|
||||||
|
(async () => {
|
||||||
|
const svg = await exportToSvg(
|
||||||
|
[textElement],
|
||||||
|
{
|
||||||
|
exportBackground: false,
|
||||||
|
viewBackgroundColor: "#fff",
|
||||||
|
exportWithDarkMode: theme === "dark",
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
{
|
||||||
|
skipInliningFonts: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
svg.querySelector(".style-fonts")?.remove();
|
||||||
|
previewNode.replaceChildren();
|
||||||
|
previewNode.appendChild(svg);
|
||||||
|
})();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
previewNode.replaceChildren();
|
||||||
|
};
|
||||||
|
}, [props.rawText, theme]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className="ChartPreview"
|
||||||
|
aria-label={t("labels.chartType_plaintext")}
|
||||||
|
onClick={() => {
|
||||||
|
props.onClick(props.rawText);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div className="ChartPreview__canvas" ref={previewRef} />
|
||||||
|
<div className="ChartPreview__label">
|
||||||
|
{t("labels.chartType_plaintext")}
|
||||||
|
</div>
|
||||||
</button>
|
</button>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const PasteChartDialog = ({
|
export const PasteChartDialog = ({
|
||||||
setAppState,
|
data,
|
||||||
appState,
|
rawText,
|
||||||
onClose,
|
onClose,
|
||||||
}: {
|
}: {
|
||||||
appState: UIAppState;
|
data: Spreadsheet;
|
||||||
|
rawText: string;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
setAppState: React.Component<any, UIAppState>["setState"];
|
|
||||||
}) => {
|
}) => {
|
||||||
const { onInsertElements } = useApp();
|
const { onInsertElements, focusContainer } = useApp();
|
||||||
|
const [colorSeed, setColorSeed] = useState(Math.random());
|
||||||
|
|
||||||
|
const handleReshuffleColors = React.useCallback(() => {
|
||||||
|
setColorSeed(Math.random());
|
||||||
|
}, []);
|
||||||
|
|
||||||
const handleClose = React.useCallback(() => {
|
const handleClose = React.useCallback(() => {
|
||||||
if (onClose) {
|
if (onClose) {
|
||||||
onClose();
|
onClose();
|
||||||
@@ -103,36 +198,72 @@ export const PasteChartDialog = ({
|
|||||||
const handleChartClick = (chartType: ChartType, elements: ChartElements) => {
|
const handleChartClick = (chartType: ChartType, elements: ChartElements) => {
|
||||||
onInsertElements(elements);
|
onInsertElements(elements);
|
||||||
trackEvent("paste", "chart", chartType);
|
trackEvent("paste", "chart", chartType);
|
||||||
setAppState({
|
onClose();
|
||||||
currentChartType: chartType,
|
focusContainer();
|
||||||
pasteDialog: {
|
};
|
||||||
shown: false,
|
|
||||||
data: null,
|
const handlePlainTextClick = (rawText: string) => {
|
||||||
},
|
const textElement = newTextElement({
|
||||||
|
text: rawText,
|
||||||
|
x: 0,
|
||||||
|
y: 0,
|
||||||
});
|
});
|
||||||
|
onInsertElements([textElement]);
|
||||||
|
trackEvent("paste", "chart", "plaintext");
|
||||||
|
onClose();
|
||||||
|
focusContainer();
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Dialog
|
<Dialog
|
||||||
size="small"
|
size="regular"
|
||||||
onCloseRequest={handleClose}
|
onCloseRequest={handleClose}
|
||||||
title={t("labels.pasteCharts")}
|
title={
|
||||||
|
<div className="PasteChartDialog__title">
|
||||||
|
<div className="PasteChartDialog__titleText">
|
||||||
|
{t("labels.pasteCharts")}
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
className="PasteChartDialog__reshuffleBtn"
|
||||||
|
onClick={handleReshuffleColors}
|
||||||
|
role="button"
|
||||||
|
tabIndex={0}
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (event.key === "Enter" || event.key === " ") {
|
||||||
|
event.preventDefault();
|
||||||
|
handleReshuffleColors();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{bucketFillIcon}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
className={"PasteChartDialog"}
|
className={"PasteChartDialog"}
|
||||||
autofocus={false}
|
autofocus={false}
|
||||||
>
|
>
|
||||||
<div className={"container"}>
|
<div className={"container"}>
|
||||||
<ChartPreviewBtn
|
{(["bar", "line", "radar"] as const).map((chartType) => {
|
||||||
chartType="bar"
|
if (!isSpreadsheetValidForChartType(data, chartType)) {
|
||||||
spreadsheet={appState.pasteDialog.data}
|
return null;
|
||||||
selected={appState.currentChartType === "bar"}
|
}
|
||||||
onClick={handleChartClick}
|
|
||||||
/>
|
return (
|
||||||
<ChartPreviewBtn
|
<ChartPreviewBtn
|
||||||
chartType="line"
|
key={chartType}
|
||||||
spreadsheet={appState.pasteDialog.data}
|
chartType={chartType}
|
||||||
selected={appState.currentChartType === "line"}
|
spreadsheet={data}
|
||||||
onClick={handleChartClick}
|
colorSeed={colorSeed}
|
||||||
/>
|
onClick={handleChartClick}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
{rawText && (
|
||||||
|
<PlainTextPreviewBtn
|
||||||
|
rawText={rawText}
|
||||||
|
onClick={handlePlainTextClick}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
</Dialog>
|
</Dialog>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import { rateLimitsAtom } from "../TTDContext";
|
|||||||
|
|
||||||
import { ChatHistoryMenu } from "./ChatHistoryMenu";
|
import { ChatHistoryMenu } from "./ChatHistoryMenu";
|
||||||
|
|
||||||
import { ChatInterface } from ".";
|
import { ChatInterface } from "./ChatInterface";
|
||||||
|
|
||||||
import type { TTDPanelAction } from "../TTDDialogPanel";
|
import type { TTDPanelAction } from "../TTDDialogPanel";
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,239 @@
|
|||||||
|
import { useEffect, useRef } from "react";
|
||||||
|
import {
|
||||||
|
Decoration,
|
||||||
|
EditorView,
|
||||||
|
keymap,
|
||||||
|
lineNumbers,
|
||||||
|
placeholder as cmPlaceholder,
|
||||||
|
drawSelection,
|
||||||
|
} from "@codemirror/view";
|
||||||
|
import { Compartment, EditorState, type Extension } from "@codemirror/state";
|
||||||
|
import {
|
||||||
|
defaultKeymap,
|
||||||
|
history,
|
||||||
|
historyKeymap,
|
||||||
|
redo,
|
||||||
|
} from "@codemirror/commands";
|
||||||
|
import { syntaxHighlighting, HighlightStyle } from "@codemirror/language";
|
||||||
|
import { tags } from "@lezer/highlight";
|
||||||
|
|
||||||
|
import type { Theme } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
import { mermaidLite } from "./mermaid-lang-lite";
|
||||||
|
|
||||||
|
export interface CodeMirrorEditorProps {
|
||||||
|
value: string;
|
||||||
|
onChange: (value: string) => void;
|
||||||
|
onKeyboardSubmit?: () => void;
|
||||||
|
placeholder?: string;
|
||||||
|
theme: Theme;
|
||||||
|
errorLine?: number | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Dark theme ----
|
||||||
|
|
||||||
|
const darkTheme = EditorView.theme(
|
||||||
|
{
|
||||||
|
"&": {
|
||||||
|
backgroundColor: "#1e1e1e",
|
||||||
|
color: "#d4d4d4",
|
||||||
|
},
|
||||||
|
".cm-content": { caretColor: "#fff" },
|
||||||
|
".cm-cursor": { borderLeftColor: "#fff" },
|
||||||
|
".cm-gutters": {
|
||||||
|
backgroundColor: "#1e1e1e",
|
||||||
|
color: "#858585",
|
||||||
|
border: "none",
|
||||||
|
},
|
||||||
|
".cm-activeLineGutter": { backgroundColor: "#2a2a2a" },
|
||||||
|
".cm-activeLine": { backgroundColor: "#2a2a2a" },
|
||||||
|
".cm-errorLine": { backgroundColor: "rgba(255, 0, 0, 0.15)" },
|
||||||
|
},
|
||||||
|
{ dark: true },
|
||||||
|
);
|
||||||
|
|
||||||
|
const darkHighlight = HighlightStyle.define([
|
||||||
|
{ tag: tags.keyword, color: "#569cd6" },
|
||||||
|
{ tag: tags.string, color: "#ce9178" },
|
||||||
|
{ tag: tags.comment, color: "#6a9955" },
|
||||||
|
{ tag: tags.number, color: "#b5cea8" },
|
||||||
|
{ tag: tags.operator, color: "#d4d4d4" },
|
||||||
|
{ tag: tags.punctuation, color: "#d4d4d4" },
|
||||||
|
{ tag: tags.variableName, color: "#9cdcfe" },
|
||||||
|
{ tag: tags.bracket, color: "#ffd700" },
|
||||||
|
]);
|
||||||
|
|
||||||
|
// ---- Light theme ----
|
||||||
|
|
||||||
|
const lightTheme = EditorView.theme({
|
||||||
|
"&": {
|
||||||
|
backgroundColor: "#ffffff",
|
||||||
|
color: "#1e1e1e",
|
||||||
|
},
|
||||||
|
".cm-content": { caretColor: "#000" },
|
||||||
|
".cm-cursor": { borderLeftColor: "#000" },
|
||||||
|
".cm-gutters": {
|
||||||
|
backgroundColor: "#fff",
|
||||||
|
color: "#999",
|
||||||
|
border: "none",
|
||||||
|
},
|
||||||
|
".cm-activeLineGutter": { backgroundColor: "#e8e8e8" },
|
||||||
|
".cm-activeLine": { backgroundColor: "#e8e8e8" },
|
||||||
|
".cm-errorLine": { backgroundColor: "rgba(255, 0, 0, 0.1)" },
|
||||||
|
});
|
||||||
|
|
||||||
|
const lightHighlight = HighlightStyle.define([
|
||||||
|
{ tag: tags.keyword, color: "#0000ff" },
|
||||||
|
{ tag: tags.string, color: "#a31515" },
|
||||||
|
{ tag: tags.comment, color: "#008000" },
|
||||||
|
{ tag: tags.number, color: "#098658" },
|
||||||
|
{ tag: tags.operator, color: "#1e1e1e" },
|
||||||
|
{ tag: tags.punctuation, color: "#1e1e1e" },
|
||||||
|
{ tag: tags.variableName, color: "#001080" },
|
||||||
|
{ tag: tags.bracket, color: "#af00db" },
|
||||||
|
]);
|
||||||
|
|
||||||
|
// ---- Error line decoration ----
|
||||||
|
|
||||||
|
const errorLineDeco = Decoration.line({ class: "cm-errorLine" });
|
||||||
|
|
||||||
|
const getErrorLineExtension = (
|
||||||
|
errorLine: number | null | undefined,
|
||||||
|
doc: { line(n: number): { from: number }; lines: number },
|
||||||
|
): Extension => {
|
||||||
|
if (!errorLine || errorLine < 1 || errorLine > doc.lines) {
|
||||||
|
return EditorView.decorations.of(Decoration.none);
|
||||||
|
}
|
||||||
|
const line = doc.line(errorLine);
|
||||||
|
return EditorView.decorations.of(
|
||||||
|
Decoration.set([errorLineDeco.range(line.from)]),
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
// ---- Helpers ----
|
||||||
|
|
||||||
|
const getThemeExtensions = (theme: Theme) => {
|
||||||
|
if (theme === "dark") {
|
||||||
|
return [darkTheme, syntaxHighlighting(darkHighlight)];
|
||||||
|
}
|
||||||
|
return [lightTheme, syntaxHighlighting(lightHighlight)];
|
||||||
|
};
|
||||||
|
|
||||||
|
const CodeMirrorEditor = ({
|
||||||
|
value,
|
||||||
|
onChange,
|
||||||
|
onKeyboardSubmit,
|
||||||
|
placeholder,
|
||||||
|
theme,
|
||||||
|
errorLine,
|
||||||
|
}: CodeMirrorEditorProps) => {
|
||||||
|
const containerRef = useRef<HTMLDivElement>(null);
|
||||||
|
const viewRef = useRef<EditorView | null>(null);
|
||||||
|
const onChangeRef = useRef(onChange);
|
||||||
|
const onKeyboardSubmitRef = useRef(onKeyboardSubmit);
|
||||||
|
const themeCompartmentRef = useRef(new Compartment());
|
||||||
|
const errorLineCompartmentRef = useRef(new Compartment());
|
||||||
|
|
||||||
|
onChangeRef.current = onChange;
|
||||||
|
onKeyboardSubmitRef.current = onKeyboardSubmit;
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!containerRef.current) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const themeCompartment = themeCompartmentRef.current;
|
||||||
|
|
||||||
|
const view = new EditorView({
|
||||||
|
state: EditorState.create({
|
||||||
|
doc: value,
|
||||||
|
extensions: [
|
||||||
|
keymap.of([
|
||||||
|
{
|
||||||
|
key: "Mod-Enter",
|
||||||
|
run: () => {
|
||||||
|
onKeyboardSubmitRef.current?.();
|
||||||
|
return true;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// historyKeymap binds Mod-Shift-z only on Mac; add it for all platforms
|
||||||
|
{ key: "Mod-Shift-z", run: redo, preventDefault: true },
|
||||||
|
]),
|
||||||
|
EditorView.updateListener.of((update) => {
|
||||||
|
if (update.docChanged) {
|
||||||
|
onChangeRef.current(update.state.doc.toString());
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
history(),
|
||||||
|
keymap.of([...defaultKeymap, ...historyKeymap]),
|
||||||
|
lineNumbers(),
|
||||||
|
EditorView.lineWrapping,
|
||||||
|
themeCompartment.of(getThemeExtensions(theme)),
|
||||||
|
errorLineCompartmentRef.current.of([]),
|
||||||
|
mermaidLite(),
|
||||||
|
drawSelection({ drawRangeCursor: true }),
|
||||||
|
...(placeholder ? [cmPlaceholder(placeholder)] : []),
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
parent: containerRef.current,
|
||||||
|
});
|
||||||
|
|
||||||
|
viewRef.current = view;
|
||||||
|
view.focus();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
view.destroy();
|
||||||
|
viewRef.current = null;
|
||||||
|
};
|
||||||
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
// Swap theme dynamically via compartment
|
||||||
|
useEffect(() => {
|
||||||
|
const view = viewRef.current;
|
||||||
|
if (!view) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
view.dispatch({
|
||||||
|
effects: themeCompartmentRef.current.reconfigure(
|
||||||
|
getThemeExtensions(theme),
|
||||||
|
),
|
||||||
|
});
|
||||||
|
}, [theme]);
|
||||||
|
|
||||||
|
// Update error line highlight
|
||||||
|
useEffect(() => {
|
||||||
|
const view = viewRef.current;
|
||||||
|
if (!view) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
view.dispatch({
|
||||||
|
effects: errorLineCompartmentRef.current.reconfigure(
|
||||||
|
getErrorLineExtension(errorLine, view.state.doc),
|
||||||
|
),
|
||||||
|
});
|
||||||
|
}, [errorLine]);
|
||||||
|
|
||||||
|
// Sync external value changes into EditorView
|
||||||
|
useEffect(() => {
|
||||||
|
const view = viewRef.current;
|
||||||
|
if (!view) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const currentDoc = view.state.doc.toString();
|
||||||
|
if (value !== currentDoc) {
|
||||||
|
view.dispatch({
|
||||||
|
changes: { from: 0, to: currentDoc.length, insert: value },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}, [value]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
ref={containerRef}
|
||||||
|
className="ttd-dialog-input ttd-dialog-input--codemirror"
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default CodeMirrorEditor;
|
||||||
@@ -17,6 +17,11 @@ import { TTDDialogOutput } from "./TTDDialogOutput";
|
|||||||
import { TTDDialogPanel } from "./TTDDialogPanel";
|
import { TTDDialogPanel } from "./TTDDialogPanel";
|
||||||
import { TTDDialogPanels } from "./TTDDialogPanels";
|
import { TTDDialogPanels } from "./TTDDialogPanels";
|
||||||
import { TTDDialogSubmitShortcut } from "./TTDDialogSubmitShortcut";
|
import { TTDDialogSubmitShortcut } from "./TTDDialogSubmitShortcut";
|
||||||
|
import {
|
||||||
|
getMermaidErrorLineNumber,
|
||||||
|
isMermaidAutoFixableError,
|
||||||
|
} from "./utils/mermaidError";
|
||||||
|
import { getMermaidAutoFixCandidates } from "./utils/mermaidAutoFix";
|
||||||
import {
|
import {
|
||||||
convertMermaidToExcalidraw,
|
convertMermaidToExcalidraw,
|
||||||
insertToEditor,
|
insertToEditor,
|
||||||
@@ -33,6 +38,27 @@ const MERMAID_EXAMPLE =
|
|||||||
"flowchart TD\n A[Christmas] -->|Get money| B(Go shopping)\n B --> C{Let me think}\n C -->|One| D[Laptop]\n C -->|Two| E[iPhone]\n C -->|Three| F[Car]";
|
"flowchart TD\n A[Christmas] -->|Get money| B(Go shopping)\n B --> C{Let me think}\n C -->|One| D[Laptop]\n C -->|Two| E[iPhone]\n C -->|Three| F[Car]";
|
||||||
|
|
||||||
const debouncedSaveMermaidDefinition = debounce(saveMermaidDataToStorage, 300);
|
const debouncedSaveMermaidDefinition = debounce(saveMermaidDataToStorage, 300);
|
||||||
|
const AUTO_FIX_DEBOUNCE_MS = 500;
|
||||||
|
const AUTO_FIX_MAX_DEPTH = 4;
|
||||||
|
const AUTO_FIX_MAX_CANDIDATES = 30;
|
||||||
|
|
||||||
|
const getErrorMessage = (error: unknown): string => {
|
||||||
|
if (error instanceof Error) {
|
||||||
|
return error.message;
|
||||||
|
}
|
||||||
|
if (typeof error === "string") {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
error &&
|
||||||
|
typeof error === "object" &&
|
||||||
|
"message" in error &&
|
||||||
|
typeof (error as { message?: unknown }).message === "string"
|
||||||
|
) {
|
||||||
|
return (error as { message: string }).message;
|
||||||
|
}
|
||||||
|
return "";
|
||||||
|
};
|
||||||
|
|
||||||
const MermaidToExcalidraw = ({
|
const MermaidToExcalidraw = ({
|
||||||
mermaidToExcalidrawLib,
|
mermaidToExcalidrawLib,
|
||||||
@@ -46,8 +72,16 @@ const MermaidToExcalidraw = ({
|
|||||||
EditorLocalStorage.get<string>(EDITOR_LS_KEYS.MERMAID_TO_EXCALIDRAW) ||
|
EditorLocalStorage.get<string>(EDITOR_LS_KEYS.MERMAID_TO_EXCALIDRAW) ||
|
||||||
MERMAID_EXAMPLE,
|
MERMAID_EXAMPLE,
|
||||||
);
|
);
|
||||||
const deferredText = useDeferredValue(text.trim());
|
const deferredText = useDeferredValue(text);
|
||||||
const [error, setError] = useState<Error | null>(null);
|
const [error, setError] = useState<Error | null>(null);
|
||||||
|
const [autoFixCandidate, setAutoFixCandidate] = useState<string | null>(null);
|
||||||
|
|
||||||
|
const errorLine = (() => {
|
||||||
|
if (!error?.message) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return getMermaidErrorLineNumber(error.message, deferredText);
|
||||||
|
})();
|
||||||
|
|
||||||
const canvasRef = useRef<HTMLDivElement>(null);
|
const canvasRef = useRef<HTMLDivElement>(null);
|
||||||
const data = useRef<{
|
const data = useRef<{
|
||||||
@@ -61,7 +95,7 @@ const MermaidToExcalidraw = ({
|
|||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const doRender = async () => {
|
const doRender = async () => {
|
||||||
try {
|
try {
|
||||||
if (!deferredText) {
|
if (!deferredText.trim()) {
|
||||||
resetPreview({ canvasRef, setError });
|
resetPreview({ canvasRef, setError });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -98,6 +132,88 @@ const MermaidToExcalidraw = ({
|
|||||||
[],
|
[],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const errorMessage = error?.message ?? "";
|
||||||
|
const sourceText = deferredText;
|
||||||
|
const shouldTryAutoFix =
|
||||||
|
isActive &&
|
||||||
|
isMermaidAutoFixableError(errorMessage) &&
|
||||||
|
!!sourceText.trim() &&
|
||||||
|
mermaidToExcalidrawLib.loaded;
|
||||||
|
|
||||||
|
if (!shouldTryAutoFix) {
|
||||||
|
setAutoFixCandidate(null);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
if (!candidates.length) {
|
||||||
|
setAutoFixCandidate(null);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let cancelled = false;
|
||||||
|
const timer = setTimeout(async () => {
|
||||||
|
try {
|
||||||
|
const api = await mermaidToExcalidrawLib.api;
|
||||||
|
const seen = new Set<string>([sourceText]);
|
||||||
|
const queue = candidates.map((candidate) => ({
|
||||||
|
text: candidate,
|
||||||
|
depth: 1,
|
||||||
|
}));
|
||||||
|
|
||||||
|
let triedCandidates = 0;
|
||||||
|
|
||||||
|
while (queue.length > 0 && triedCandidates < AUTO_FIX_MAX_CANDIDATES) {
|
||||||
|
const current = queue.shift();
|
||||||
|
if (!current || seen.has(current.text)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
seen.add(current.text);
|
||||||
|
triedCandidates += 1;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await api.parseMermaidToExcalidraw(current.text);
|
||||||
|
if (!cancelled) {
|
||||||
|
setAutoFixCandidate(current.text);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
} catch (candidateError) {
|
||||||
|
if (current.depth >= AUTO_FIX_MAX_DEPTH) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const nextErrorMessage = getErrorMessage(candidateError);
|
||||||
|
if (!nextErrorMessage) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const nextCandidates = getMermaidAutoFixCandidates(
|
||||||
|
current.text,
|
||||||
|
nextErrorMessage,
|
||||||
|
);
|
||||||
|
for (const nextCandidate of nextCandidates) {
|
||||||
|
if (!seen.has(nextCandidate)) {
|
||||||
|
queue.push({
|
||||||
|
text: nextCandidate,
|
||||||
|
depth: current.depth + 1,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// ignore auto-fix probe errors
|
||||||
|
}
|
||||||
|
if (!cancelled) {
|
||||||
|
setAutoFixCandidate(null);
|
||||||
|
}
|
||||||
|
}, AUTO_FIX_DEBOUNCE_MS);
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
cancelled = true;
|
||||||
|
clearTimeout(timer);
|
||||||
|
};
|
||||||
|
}, [deferredText, error?.message, isActive, mermaidToExcalidrawLib]);
|
||||||
|
|
||||||
const onInsertToEditor = () => {
|
const onInsertToEditor = () => {
|
||||||
insertToEditor({
|
insertToEditor({
|
||||||
app,
|
app,
|
||||||
@@ -107,6 +223,13 @@ const MermaidToExcalidraw = ({
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const onApplyAutoFix = () => {
|
||||||
|
if (!autoFixCandidate) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setText(autoFixCandidate);
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<div className="ttd-dialog-desc">
|
<div className="ttd-dialog-desc">
|
||||||
@@ -130,7 +253,8 @@ const MermaidToExcalidraw = ({
|
|||||||
<TTDDialogInput
|
<TTDDialogInput
|
||||||
input={text}
|
input={text}
|
||||||
placeholder={t("mermaid.inputPlaceholder")}
|
placeholder={t("mermaid.inputPlaceholder")}
|
||||||
onChange={(event) => setText(event.target.value)}
|
onChange={(value) => setText(value)}
|
||||||
|
errorLine={errorLine}
|
||||||
onKeyboardSubmit={() => {
|
onKeyboardSubmit={() => {
|
||||||
onInsertToEditor();
|
onInsertToEditor();
|
||||||
}}
|
}}
|
||||||
@@ -153,6 +277,9 @@ const MermaidToExcalidraw = ({
|
|||||||
canvasRef={canvasRef}
|
canvasRef={canvasRef}
|
||||||
loaded={mermaidToExcalidrawLib.loaded}
|
loaded={mermaidToExcalidrawLib.loaded}
|
||||||
error={error}
|
error={error}
|
||||||
|
sourceText={text}
|
||||||
|
autoFixAvailable={!!autoFixCandidate}
|
||||||
|
onApplyAutoFix={onApplyAutoFix}
|
||||||
/>
|
/>
|
||||||
</TTDDialogPanel>
|
</TTDDialogPanel>
|
||||||
</TTDDialogPanels>
|
</TTDDialogPanels>
|
||||||
|
|||||||
@@ -219,6 +219,49 @@ $fullScreenModalBreakpoint: 600px;
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.ttd-dialog-input--loading {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ttd-dialog-input--codemirror {
|
||||||
|
padding: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
// Override height:100% from .ttd-dialog-input — use flex sizing
|
||||||
|
// so the editor fills remaining space without overflowing the panel
|
||||||
|
height: 0;
|
||||||
|
flex: 1 1 0;
|
||||||
|
min-height: 0;
|
||||||
|
|
||||||
|
.cm-editor {
|
||||||
|
height: 100%;
|
||||||
|
font-family: monospace;
|
||||||
|
|
||||||
|
&.cm-focused {
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.cm-scroller {
|
||||||
|
padding: 0.85rem 0;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.cm-gutters {
|
||||||
|
padding-left: 0.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.cm-content {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.cm-placeholder {
|
||||||
|
color: var(--color-gray-40);
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.ttd-dialog-output-wrapper {
|
.ttd-dialog-output-wrapper {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
@@ -331,14 +374,55 @@ $fullScreenModalBreakpoint: 600px;
|
|||||||
margin-top: 0.25rem;
|
margin-top: 0.25rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.ttd-dialog-output-error-summary {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 640px;
|
||||||
|
color: var(--color-gray-50);
|
||||||
|
font-size: 0.9rem;
|
||||||
|
text-align: left;
|
||||||
|
|
||||||
|
&__headline {
|
||||||
|
font-weight: 600;
|
||||||
|
color: var(--color-gray-60);
|
||||||
|
}
|
||||||
|
|
||||||
|
&__label {
|
||||||
|
margin-top: 0.35rem;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
&__causes {
|
||||||
|
margin: 0.35rem 0 0;
|
||||||
|
padding-left: 2rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.ttd-dialog-output-error-message {
|
.ttd-dialog-output-error-message {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
color: var(--color-gray-50);
|
color: var(--color-gray-50);
|
||||||
word-break: break-word;
|
word-break: break-word;
|
||||||
white-space: pre-wrap;
|
white-space: pre-wrap;
|
||||||
max-width: 100%;
|
max-width: 640px;
|
||||||
|
width: 100%;
|
||||||
font-family: monospace;
|
font-family: monospace;
|
||||||
|
|
||||||
|
&__caret {
|
||||||
|
color: var(--color-danger);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.ttd-dialog-output-error-autofix-slot {
|
||||||
|
align-self: flex-start;
|
||||||
|
margin-top: 0.35rem;
|
||||||
|
min-height: 2.5rem;
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ttd-dialog-output-error-autofix {
|
||||||
|
margin-top: 0;
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,28 +1,84 @@
|
|||||||
import { useEffect, useRef } from "react";
|
import { useEffect, useRef, useState } from "react";
|
||||||
|
|
||||||
import { EVENT, KEYS } from "@excalidraw/common";
|
import { EVENT, KEYS } from "@excalidraw/common";
|
||||||
|
|
||||||
import type { ChangeEventHandler } from "react";
|
import Spinner from "../Spinner";
|
||||||
|
|
||||||
|
import { useUIAppState } from "../../context/ui-appState";
|
||||||
|
|
||||||
|
import type { ComponentType } from "react";
|
||||||
|
import type { CodeMirrorEditorProps } from "./CodeMirrorEditor";
|
||||||
|
|
||||||
interface TTDDialogInputProps {
|
interface TTDDialogInputProps {
|
||||||
input: string;
|
input: string;
|
||||||
placeholder: string;
|
placeholder: string;
|
||||||
onChange: ChangeEventHandler<HTMLTextAreaElement>;
|
onChange: (value: string) => void;
|
||||||
onKeyboardSubmit?: () => void;
|
onKeyboardSubmit?: () => void;
|
||||||
|
errorLine?: number | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type EditorState =
|
||||||
|
| { type: "loading" }
|
||||||
|
| { type: "ready"; component: ComponentType<CodeMirrorEditorProps> }
|
||||||
|
| { type: "fallback" };
|
||||||
|
|
||||||
|
const SPINNER_DELAY_MS = 300;
|
||||||
|
|
||||||
export const TTDDialogInput = ({
|
export const TTDDialogInput = ({
|
||||||
input,
|
input,
|
||||||
placeholder,
|
placeholder,
|
||||||
onChange,
|
onChange,
|
||||||
onKeyboardSubmit,
|
onKeyboardSubmit,
|
||||||
|
errorLine,
|
||||||
}: TTDDialogInputProps) => {
|
}: TTDDialogInputProps) => {
|
||||||
const ref = useRef<HTMLTextAreaElement>(null);
|
const ref = useRef<HTMLTextAreaElement>(null);
|
||||||
|
|
||||||
const callbackRef = useRef(onKeyboardSubmit);
|
const callbackRef = useRef(onKeyboardSubmit);
|
||||||
callbackRef.current = onKeyboardSubmit;
|
callbackRef.current = onKeyboardSubmit;
|
||||||
|
|
||||||
|
const [editorState, setEditorState] = useState<EditorState>({
|
||||||
|
type: "loading",
|
||||||
|
});
|
||||||
|
const [showSpinner, setShowSpinner] = useState(false);
|
||||||
|
|
||||||
|
const { theme } = useUIAppState();
|
||||||
|
|
||||||
|
// Lazy-load CodeMirror editor
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
|
let cancelled = false;
|
||||||
|
|
||||||
|
const spinnerTimer = setTimeout(() => {
|
||||||
|
if (!cancelled) {
|
||||||
|
setShowSpinner(true);
|
||||||
|
}
|
||||||
|
}, SPINNER_DELAY_MS);
|
||||||
|
|
||||||
|
import("./CodeMirrorEditor")
|
||||||
|
.then((mod) => {
|
||||||
|
if (!cancelled) {
|
||||||
|
setEditorState({ type: "ready", component: mod.default });
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
if (!cancelled) {
|
||||||
|
setEditorState({ type: "fallback" });
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.finally(() => {
|
||||||
|
clearTimeout(spinnerTimer);
|
||||||
|
});
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
cancelled = true;
|
||||||
|
clearTimeout(spinnerTimer);
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
// Keyboard shortcut + focus for textarea fallback
|
||||||
|
useEffect(() => {
|
||||||
|
if (editorState.type !== "fallback") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
if (!callbackRef.current) {
|
if (!callbackRef.current) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -40,15 +96,42 @@ export const TTDDialogInput = ({
|
|||||||
textarea.removeEventListener(EVENT.KEYDOWN, handleKeyDown);
|
textarea.removeEventListener(EVENT.KEYDOWN, handleKeyDown);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}, []);
|
}, [editorState.type]);
|
||||||
|
|
||||||
return (
|
if (editorState.type === "ready") {
|
||||||
<textarea
|
const CodeMirrorEditor = editorState.component;
|
||||||
className="ttd-dialog-input"
|
return (
|
||||||
onChange={onChange}
|
<CodeMirrorEditor
|
||||||
value={input}
|
value={input}
|
||||||
placeholder={placeholder}
|
onChange={onChange}
|
||||||
ref={ref}
|
onKeyboardSubmit={onKeyboardSubmit}
|
||||||
/>
|
placeholder={placeholder}
|
||||||
);
|
theme={theme}
|
||||||
|
errorLine={errorLine}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (editorState.type === "fallback") {
|
||||||
|
return (
|
||||||
|
<textarea
|
||||||
|
className="ttd-dialog-input"
|
||||||
|
onChange={(e) => onChange(e.target.value)}
|
||||||
|
value={input}
|
||||||
|
placeholder={placeholder}
|
||||||
|
ref={ref}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Loading state
|
||||||
|
if (showSpinner) {
|
||||||
|
return (
|
||||||
|
<div className="ttd-dialog-input ttd-dialog-input--loading">
|
||||||
|
<Spinner />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,14 +1,24 @@
|
|||||||
import clsx from "clsx";
|
import clsx from "clsx";
|
||||||
|
|
||||||
|
import { Button } from "../Button";
|
||||||
import Spinner from "../Spinner";
|
import Spinner from "../Spinner";
|
||||||
import { t } from "../../i18n";
|
import { t } from "../../i18n";
|
||||||
import { alertTriangleIcon } from "../icons";
|
import { alertTriangleIcon } from "../icons";
|
||||||
|
|
||||||
|
import {
|
||||||
|
formatMermaidParseErrorMessage,
|
||||||
|
getMermaidSyntaxErrorGuidance,
|
||||||
|
isMermaidCaretLine,
|
||||||
|
} from "./utils/mermaidError";
|
||||||
|
|
||||||
interface TTDDialogOutputProps {
|
interface TTDDialogOutputProps {
|
||||||
error: Error | null;
|
error: Error | null;
|
||||||
canvasRef: React.RefObject<HTMLDivElement | null>;
|
canvasRef: React.RefObject<HTMLDivElement | null>;
|
||||||
loaded: boolean;
|
loaded: boolean;
|
||||||
hideErrorDetails?: boolean;
|
hideErrorDetails?: boolean;
|
||||||
|
sourceText?: string;
|
||||||
|
autoFixAvailable?: boolean;
|
||||||
|
onApplyAutoFix?: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const TTDDialogOutput = ({
|
export const TTDDialogOutput = ({
|
||||||
@@ -16,7 +26,24 @@ export const TTDDialogOutput = ({
|
|||||||
canvasRef,
|
canvasRef,
|
||||||
loaded,
|
loaded,
|
||||||
hideErrorDetails,
|
hideErrorDetails,
|
||||||
|
sourceText,
|
||||||
|
autoFixAvailable,
|
||||||
|
onApplyAutoFix,
|
||||||
}: TTDDialogOutputProps) => {
|
}: TTDDialogOutputProps) => {
|
||||||
|
const errorMessage = error
|
||||||
|
? hideErrorDetails
|
||||||
|
? t("chat.errors.mermaidParseError")
|
||||||
|
: formatMermaidParseErrorMessage(error.message)
|
||||||
|
: null;
|
||||||
|
const syntaxGuidance =
|
||||||
|
error && !hideErrorDetails
|
||||||
|
? getMermaidSyntaxErrorGuidance(error.message, sourceText)
|
||||||
|
: null;
|
||||||
|
const showAutoFixButton =
|
||||||
|
!!autoFixAvailable && !!onApplyAutoFix && !hideErrorDetails;
|
||||||
|
|
||||||
|
const errorMessageLines = errorMessage?.split(/\r?\n/) ?? [];
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
className={`ttd-dialog-output-wrapper ${
|
className={`ttd-dialog-output-wrapper ${
|
||||||
@@ -33,14 +60,48 @@ export const TTDDialogOutput = ({
|
|||||||
<div className="ttd-dialog-output-error-icon">
|
<div className="ttd-dialog-output-error-icon">
|
||||||
{alertTriangleIcon}
|
{alertTriangleIcon}
|
||||||
</div>
|
</div>
|
||||||
<div className="ttd-dialog-output-error-title">
|
{syntaxGuidance && (
|
||||||
{t("ttd.error")}
|
<div className="ttd-dialog-output-error-summary">
|
||||||
</div>
|
<div className="ttd-dialog-output-error-summary__headline">
|
||||||
|
{syntaxGuidance.summary}
|
||||||
|
</div>
|
||||||
|
<div className="ttd-dialog-output-error-summary__label">
|
||||||
|
Likely causes:
|
||||||
|
</div>
|
||||||
|
<ul className="ttd-dialog-output-error-summary__causes">
|
||||||
|
{syntaxGuidance.likelyCauses.map((cause) => (
|
||||||
|
<li key={cause}>{cause}</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
<div className="ttd-dialog-output-error-message">
|
<div className="ttd-dialog-output-error-message">
|
||||||
{hideErrorDetails
|
{errorMessageLines.map((line, index) => (
|
||||||
? t("chat.errors.mermaidParseError")
|
<span
|
||||||
: error.message}
|
key={`error-line-${index}`}
|
||||||
|
className={
|
||||||
|
isMermaidCaretLine(line)
|
||||||
|
? "ttd-dialog-output-error-message__caret"
|
||||||
|
: undefined
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{line}
|
||||||
|
{index < errorMessageLines.length - 1 ? "\n" : ""}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
</div>
|
</div>
|
||||||
|
{!hideErrorDetails && (
|
||||||
|
<div className="ttd-dialog-output-error-autofix-slot">
|
||||||
|
{showAutoFixButton ? (
|
||||||
|
<Button
|
||||||
|
className="ttd-dialog-panel-button ttd-dialog-output-error-autofix"
|
||||||
|
onSelect={onApplyAutoFix}
|
||||||
|
>
|
||||||
|
{t("mermaid.autoFixAvailable")}
|
||||||
|
</Button>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { getShortcutKey } from "@excalidraw/excalidraw/shortcut";
|
import { getShortcutKey } from "../../shortcut";
|
||||||
|
|
||||||
export const TTDDialogSubmitShortcut = () => {
|
export const TTDDialogSubmitShortcut = () => {
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -0,0 +1,89 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
|
||||||
|
import { convertMermaidToExcalidraw } from "./common";
|
||||||
|
|
||||||
|
type ConvertMermaidArgs = Parameters<typeof convertMermaidToExcalidraw>[0];
|
||||||
|
type ParseMermaidToExcalidraw = Awaited<
|
||||||
|
ConvertMermaidArgs["mermaidToExcalidrawLib"]["api"]
|
||||||
|
>["parseMermaidToExcalidraw"];
|
||||||
|
|
||||||
|
const createConvertArgs = (
|
||||||
|
mermaidDefinition: string,
|
||||||
|
parseMermaidToExcalidraw: ParseMermaidToExcalidraw,
|
||||||
|
): ConvertMermaidArgs => {
|
||||||
|
const parent = document.createElement("div");
|
||||||
|
const canvas = document.createElement("div");
|
||||||
|
parent.appendChild(canvas);
|
||||||
|
|
||||||
|
return {
|
||||||
|
canvasRef: { current: canvas },
|
||||||
|
mermaidToExcalidrawLib: {
|
||||||
|
loaded: true,
|
||||||
|
api: Promise.resolve({ parseMermaidToExcalidraw }),
|
||||||
|
},
|
||||||
|
mermaidDefinition,
|
||||||
|
setError: vi.fn(),
|
||||||
|
data: {
|
||||||
|
current: {
|
||||||
|
elements: [],
|
||||||
|
files: null,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
theme: "light",
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("convertMermaidToExcalidraw", () => {
|
||||||
|
it("returns the original parse error when quote-normalized fallback also fails", async () => {
|
||||||
|
const originalError = new Error("Parse error on line 9: ...");
|
||||||
|
const fallbackError = new Error("Parse error on line 6: ...");
|
||||||
|
|
||||||
|
const parseMermaidToExcalidraw = vi
|
||||||
|
.fn<ParseMermaidToExcalidraw>()
|
||||||
|
.mockRejectedValueOnce(originalError)
|
||||||
|
.mockRejectedValueOnce(fallbackError);
|
||||||
|
|
||||||
|
const mermaidDefinition =
|
||||||
|
'graph TD\nA["One"]\nB["Two"]x\nC["Three"]\nD["Four"]';
|
||||||
|
|
||||||
|
const result = await convertMermaidToExcalidraw(
|
||||||
|
createConvertArgs(mermaidDefinition, parseMermaidToExcalidraw),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(parseMermaidToExcalidraw).toHaveBeenCalledTimes(2);
|
||||||
|
expect(parseMermaidToExcalidraw).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
mermaidDefinition,
|
||||||
|
);
|
||||||
|
expect(parseMermaidToExcalidraw).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
mermaidDefinition.replace(/"/g, "'"),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(result.success).toBe(false);
|
||||||
|
if (!result.success) {
|
||||||
|
expect(result.error).toBe(originalError);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not retry quote normalization when the input has no double quotes", async () => {
|
||||||
|
const originalError = new Error("Parse error on line 9: ...");
|
||||||
|
const parseMermaidToExcalidraw = vi
|
||||||
|
.fn<ParseMermaidToExcalidraw>()
|
||||||
|
.mockRejectedValueOnce(originalError);
|
||||||
|
|
||||||
|
const mermaidDefinition = "graph TD\nA[One]\nB[Two]x";
|
||||||
|
|
||||||
|
const result = await convertMermaidToExcalidraw(
|
||||||
|
createConvertArgs(mermaidDefinition, parseMermaidToExcalidraw),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(parseMermaidToExcalidraw).toHaveBeenCalledTimes(1);
|
||||||
|
expect(parseMermaidToExcalidraw).toHaveBeenCalledWith(mermaidDefinition);
|
||||||
|
|
||||||
|
expect(result.success).toBe(false);
|
||||||
|
if (!result.success) {
|
||||||
|
expect(result.error).toBe(originalError);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,4 +1,12 @@
|
|||||||
import { DEFAULT_EXPORT_PADDING, EDITOR_LS_KEYS } from "@excalidraw/common";
|
import {
|
||||||
|
DEFAULT_EXPORT_PADDING,
|
||||||
|
EDITOR_LS_KEYS,
|
||||||
|
THEME,
|
||||||
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
|
import { convertToExcalidrawElements } from "@excalidraw/element";
|
||||||
|
|
||||||
|
import { exportToCanvas } from "@excalidraw/utils";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
NonDeletedExcalidrawElement,
|
NonDeletedExcalidrawElement,
|
||||||
@@ -6,11 +14,6 @@ import type {
|
|||||||
} from "@excalidraw/element/types";
|
} from "@excalidraw/element/types";
|
||||||
|
|
||||||
import { EditorLocalStorage } from "../../data/EditorLocalStorage";
|
import { EditorLocalStorage } from "../../data/EditorLocalStorage";
|
||||||
import {
|
|
||||||
convertToExcalidrawElements,
|
|
||||||
exportToCanvas,
|
|
||||||
THEME,
|
|
||||||
} from "../../index";
|
|
||||||
|
|
||||||
import type { MermaidToExcalidrawLibProps } from "./types";
|
import type { MermaidToExcalidrawLibProps } from "./types";
|
||||||
|
|
||||||
@@ -72,15 +75,23 @@ export const convertMermaidToExcalidraw = async ({
|
|||||||
const api = await mermaidToExcalidrawLib.api;
|
const api = await mermaidToExcalidrawLib.api;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
ret = await api.parseMermaidToExcalidraw(mermaidDefinition);
|
||||||
|
} catch (err: unknown) {
|
||||||
|
const originalParseError = err as Error;
|
||||||
|
|
||||||
|
if (!mermaidDefinition.includes('"')) {
|
||||||
|
return { success: false, error: originalParseError };
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
ret = await api.parseMermaidToExcalidraw(mermaidDefinition);
|
|
||||||
} catch (err: unknown) {
|
|
||||||
ret = await api.parseMermaidToExcalidraw(
|
ret = await api.parseMermaidToExcalidraw(
|
||||||
mermaidDefinition.replace(/"/g, "'"),
|
mermaidDefinition.replace(/"/g, "'"),
|
||||||
);
|
);
|
||||||
|
} catch {
|
||||||
|
// Keep the original error so line/column references stay aligned with
|
||||||
|
// the user's unmodified input.
|
||||||
|
return { success: false, error: originalParseError };
|
||||||
}
|
}
|
||||||
} catch (err: unknown) {
|
|
||||||
return { success: false, error: err as Error };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { elements, files } = ret;
|
const { elements, files } = ret;
|
||||||
|
|||||||
@@ -0,0 +1,82 @@
|
|||||||
|
import { StreamLanguage } from "@codemirror/language";
|
||||||
|
|
||||||
|
const mermaidStreamParser = StreamLanguage.define({
|
||||||
|
token(stream) {
|
||||||
|
// Comments: %%...
|
||||||
|
if (stream.match(/^%%.*$/)) {
|
||||||
|
return "comment";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Strings
|
||||||
|
if (stream.match(/^"(?:[^"\\]|\\.)*"/)) {
|
||||||
|
return "string";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Diagram type keywords (at start of line or after whitespace)
|
||||||
|
if (
|
||||||
|
stream.match(
|
||||||
|
/^(flowchart|graph|sequenceDiagram|classDiagram|stateDiagram|erDiagram|gantt|pie|mindmap|journey|gitGraph|timeline|quadrantChart|sankey|xychart)\b/i,
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
return "keyword";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Direction keywords
|
||||||
|
if (stream.match(/^(TB|TD|BT|RL|LR)\b/)) {
|
||||||
|
return "keyword";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keywords
|
||||||
|
if (
|
||||||
|
stream.match(
|
||||||
|
/^(subgraph|end|participant|actor|loop|alt|else|opt|par|critical|break|rect|note|over|activate|deactivate|title|section|class|style|linkStyle|classDef|click)\b/i,
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
return "keyword";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Arrows: -->, ---, -.->, ===>, etc.
|
||||||
|
if (stream.match(/^[-.=<>|ox]+>/)) {
|
||||||
|
return "operator";
|
||||||
|
}
|
||||||
|
if (stream.match(/^<[-.=<>|ox]+/)) {
|
||||||
|
return "operator";
|
||||||
|
}
|
||||||
|
if (stream.match(/^--+|\.\.+|==+/)) {
|
||||||
|
return "operator";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Labels in brackets/parens: [text], (text), {text}, ((text)), etc.
|
||||||
|
if (stream.match(/^[[\](){}|<>]/)) {
|
||||||
|
return "bracket";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Node IDs (alphanumeric)
|
||||||
|
if (stream.match(/^[A-Za-z_][A-Za-z0-9_]*/)) {
|
||||||
|
return "variableName";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Numbers
|
||||||
|
if (stream.match(/^\d+(\.\d+)?/)) {
|
||||||
|
return "number";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Punctuation
|
||||||
|
if (stream.match(/^[,:;]/)) {
|
||||||
|
return "punctuation";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip whitespace
|
||||||
|
if (stream.eatSpace()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip any other character
|
||||||
|
stream.next();
|
||||||
|
return null;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
export function mermaidLite() {
|
||||||
|
return mermaidStreamParser;
|
||||||
|
}
|
||||||
@@ -1,9 +1,6 @@
|
|||||||
import { RequestError } from "@excalidraw/excalidraw/errors";
|
import { RequestError } from "../../../errors";
|
||||||
|
|
||||||
import type {
|
import type { LLMMessage, TTTDDialog } from "../types";
|
||||||
LLMMessage,
|
|
||||||
TTTDDialog,
|
|
||||||
} from "@excalidraw/excalidraw/components/TTDDialog/types";
|
|
||||||
|
|
||||||
interface RateLimitInfo {
|
interface RateLimitInfo {
|
||||||
rateLimit?: number;
|
rateLimit?: number;
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import { getMermaidAutoFixCandidates } from "./mermaidAutoFix";
|
||||||
|
|
||||||
|
describe("getMermaidAutoFixCandidates", () => {
|
||||||
|
it("suggests removing trailing token after a closed label shape", () => {
|
||||||
|
const sourceText = `graph TD
|
||||||
|
L3_TCP["TCP (Transmission Control Protocol)"]x
|
||||||
|
L3_UDP["UDP (User Datagram Protocol)"]`;
|
||||||
|
|
||||||
|
const errorMessage = `Parse error on line 2:
|
||||||
|
...ission Control Protocol)"]x
|
||||||
|
-----------------------------^
|
||||||
|
Expecting 'SEMI', got 'NODE_STRING'`;
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`graph TD
|
||||||
|
L3_TCP["TCP (Transmission Control Protocol)"]
|
||||||
|
L3_UDP["UDP (User Datagram Protocol)"]`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("suggests appending missing end statements", () => {
|
||||||
|
const sourceText = `graph TD
|
||||||
|
subgraph A
|
||||||
|
A1[Start]`;
|
||||||
|
|
||||||
|
const errorMessage = `Parse error on line 3:
|
||||||
|
... A1[Start]
|
||||||
|
-------------^
|
||||||
|
Expecting 'end'`;
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`graph TD
|
||||||
|
subgraph A
|
||||||
|
A1[Start]
|
||||||
|
end`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns empty list for non-parse errors", () => {
|
||||||
|
expect(
|
||||||
|
getMermaidAutoFixCandidates("graph TD\nA-->B", "Network error"),
|
||||||
|
).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("extracts line index from lexical error format too", () => {
|
||||||
|
const sourceText = `graph TD
|
||||||
|
subgraph Layers["X"]x
|
||||||
|
direction TB`;
|
||||||
|
|
||||||
|
const errorMessage = `Lexical error on line 2. Unrecognized text.
|
||||||
|
... subgraph Layers["X"]x direction
|
||||||
|
-----------------------^`;
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`graph TD
|
||||||
|
subgraph Layers["X"]
|
||||||
|
direction TB`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("removes extra > after edge label", () => {
|
||||||
|
const sourceText = `flowchart TD
|
||||||
|
A["User Input"] -->|text|> B["Tokenization"]
|
||||||
|
A["User Input"] -->|text|> B["Tokenization"]`;
|
||||||
|
|
||||||
|
const errorMessage = `Parse error on line 2:
|
||||||
|
...A["User Input"] -->|text|> B["Tokenization"]
|
||||||
|
---------------------------^
|
||||||
|
Expecting 'NODE_STRING', got 'GT'`;
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`flowchart TD
|
||||||
|
A["User Input"] -->|text| B["Tokenization"]
|
||||||
|
A["User Input"] -->|text| B["Tokenization"]`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("suggests removing the last invalid deactivate for participant errors", () => {
|
||||||
|
const sourceText = `sequenceDiagram
|
||||||
|
participant QAEngineer as QA
|
||||||
|
activate QA
|
||||||
|
QA->>QA: Verifies Fix
|
||||||
|
deactivate QA
|
||||||
|
QA->>QA: Verifies Again
|
||||||
|
deactivate QA`;
|
||||||
|
|
||||||
|
const errorMessage = "Trying to inactivate an inactive participant (QA)";
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`sequenceDiagram
|
||||||
|
participant QAEngineer as QA
|
||||||
|
activate QA
|
||||||
|
QA->>QA: Verifies Fix
|
||||||
|
deactivate QA
|
||||||
|
QA->>QA: Verifies Again`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("adds a fallback candidate that removes all invalid deactivations", () => {
|
||||||
|
const sourceText = `sequenceDiagram
|
||||||
|
participant QAEngineer as QA
|
||||||
|
deactivate QA
|
||||||
|
QA->>QA: Verifies Fix
|
||||||
|
deactivate QA`;
|
||||||
|
|
||||||
|
const errorMessage = "Trying to inactivate an inactive participant (QA)";
|
||||||
|
|
||||||
|
const candidates = getMermaidAutoFixCandidates(sourceText, errorMessage);
|
||||||
|
|
||||||
|
expect(candidates).toContain(`sequenceDiagram
|
||||||
|
participant QAEngineer as QA
|
||||||
|
QA->>QA: Verifies Fix`);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
import {
|
||||||
|
getMermaidErrorLineNumber,
|
||||||
|
getMermaidInactiveParticipant,
|
||||||
|
isMermaidAutoFixableError,
|
||||||
|
isMermaidParseSyntaxError,
|
||||||
|
} from "./mermaidError";
|
||||||
|
|
||||||
|
const getErrorLineIndex = (message: string, sourceText: string) => {
|
||||||
|
const lineNumber = getMermaidErrorLineNumber(message, sourceText);
|
||||||
|
if (lineNumber == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return lineNumber - 1;
|
||||||
|
};
|
||||||
|
|
||||||
|
const replaceLineAt = (
|
||||||
|
lines: string[],
|
||||||
|
index: number,
|
||||||
|
transform: (line: string) => string,
|
||||||
|
) => {
|
||||||
|
if (index < 0 || index >= lines.length) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
const nextLine = transform(lines[index]);
|
||||||
|
if (nextLine === lines[index]) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
const nextLines = [...lines];
|
||||||
|
nextLines[index] = nextLine;
|
||||||
|
return nextLines.join("\n");
|
||||||
|
};
|
||||||
|
|
||||||
|
const stripTrailingTokenAfterShape = (line: string) => {
|
||||||
|
const alphaTailMatch = line.match(
|
||||||
|
/^(.*(?:\[[^\]]*]|\([^)]*\)|\{[^}]*}|"(?:[^"]*)"|'(?:[^']*)'))([A-Za-z]+)\s*$/,
|
||||||
|
);
|
||||||
|
if (alphaTailMatch) {
|
||||||
|
return alphaTailMatch[1];
|
||||||
|
}
|
||||||
|
|
||||||
|
const punctuationTailMatch = line.match(
|
||||||
|
/^(.*(?:\[[^\]]*]|\([^)]*\)|\{[^}]*}|"(?:[^"]*)"|'(?:[^']*)'))([,;:])\s*$/,
|
||||||
|
);
|
||||||
|
if (punctuationTailMatch) {
|
||||||
|
return punctuationTailMatch[1];
|
||||||
|
}
|
||||||
|
|
||||||
|
return line;
|
||||||
|
};
|
||||||
|
|
||||||
|
const removeExtraArrowheadAfterEdgeLabel = (line: string) => {
|
||||||
|
// Common typo in generated Mermaid: `-->|label|> Target` (extra `>`).
|
||||||
|
// Convert it to `-->|label| Target`.
|
||||||
|
return line.replace(/(\|[^|\n]+\|)\s*>\s*(?=[A-Za-z0-9_("[{'`])/g, "$1 ");
|
||||||
|
};
|
||||||
|
|
||||||
|
const escapeRegExp = (value: string) =>
|
||||||
|
value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
|
|
||||||
|
const removeLastDeactivateForParticipant = (
|
||||||
|
sourceText: string,
|
||||||
|
participant: string,
|
||||||
|
) => {
|
||||||
|
const pattern = new RegExp(
|
||||||
|
`^\\s*deactivate\\s+${escapeRegExp(participant)}(?:\\s+%%.*)?\\s*$`,
|
||||||
|
);
|
||||||
|
const lines = sourceText.split(/\r?\n/);
|
||||||
|
|
||||||
|
for (let index = lines.length - 1; index >= 0; index--) {
|
||||||
|
if (pattern.test(lines[index])) {
|
||||||
|
return lines.filter((_, lineIndex) => lineIndex !== index).join("\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const removeAllDeactivateForParticipant = (
|
||||||
|
sourceText: string,
|
||||||
|
participant: string,
|
||||||
|
) => {
|
||||||
|
const pattern = new RegExp(
|
||||||
|
`^\\s*deactivate\\s+${escapeRegExp(participant)}(?:\\s+%%.*)?\\s*$`,
|
||||||
|
);
|
||||||
|
const lines = sourceText.split(/\r?\n/);
|
||||||
|
let removedAny = false;
|
||||||
|
const remainingLines = lines.filter((line) => {
|
||||||
|
if (!pattern.test(line)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
removedAny = true;
|
||||||
|
return false;
|
||||||
|
});
|
||||||
|
|
||||||
|
return removedAny ? remainingLines.join("\n") : null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const appendMissingEnds = (sourceText: string) => {
|
||||||
|
const subgraphCount = (sourceText.match(/^\s*subgraph\b/gm) || []).length;
|
||||||
|
const endCount = (sourceText.match(/^\s*end\s*$/gm) || []).length;
|
||||||
|
const missingCount = subgraphCount - endCount;
|
||||||
|
|
||||||
|
if (missingCount <= 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const endings = Array.from({ length: missingCount }, () => "end").join("\n");
|
||||||
|
return `${sourceText.trimEnd()}\n${endings}`;
|
||||||
|
};
|
||||||
|
|
||||||
|
const normalizeSmartQuotes = (sourceText: string) =>
|
||||||
|
sourceText.replace(/[“”]/g, '"').replace(/[‘’]/g, "'");
|
||||||
|
|
||||||
|
export const getMermaidAutoFixCandidates = (
|
||||||
|
sourceText: string,
|
||||||
|
errorMessage: string,
|
||||||
|
) => {
|
||||||
|
if (!isMermaidAutoFixableError(errorMessage) || !sourceText.trim()) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const candidates: string[] = [];
|
||||||
|
const seen = new Set<string>();
|
||||||
|
const addCandidate = (candidate: string | null) => {
|
||||||
|
if (!candidate || candidate === sourceText || seen.has(candidate)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
seen.add(candidate);
|
||||||
|
candidates.push(candidate);
|
||||||
|
};
|
||||||
|
|
||||||
|
const inactiveParticipant = getMermaidInactiveParticipant(errorMessage);
|
||||||
|
if (inactiveParticipant) {
|
||||||
|
addCandidate(
|
||||||
|
removeLastDeactivateForParticipant(sourceText, inactiveParticipant),
|
||||||
|
);
|
||||||
|
// Fallback for repeated invalid inactivations in one diagram.
|
||||||
|
addCandidate(
|
||||||
|
removeAllDeactivateForParticipant(sourceText, inactiveParticipant),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isMermaidParseSyntaxError(errorMessage)) {
|
||||||
|
const lines = sourceText.split(/\r?\n/);
|
||||||
|
const errorLineIndex = getErrorLineIndex(errorMessage, sourceText);
|
||||||
|
const lineIndexesToTry =
|
||||||
|
errorLineIndex == null
|
||||||
|
? []
|
||||||
|
: [errorLineIndex, errorLineIndex - 1, errorLineIndex + 1];
|
||||||
|
|
||||||
|
for (const lineIndex of lineIndexesToTry) {
|
||||||
|
addCandidate(
|
||||||
|
replaceLineAt(lines, lineIndex, (line) =>
|
||||||
|
stripTrailingTokenAfterShape(line),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
addCandidate(
|
||||||
|
replaceLineAt(lines, lineIndex, (line) =>
|
||||||
|
removeExtraArrowheadAfterEdgeLabel(line),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Also try full-text replacement so repeated occurrences on other lines
|
||||||
|
// are fixed together in a single candidate.
|
||||||
|
addCandidate(removeExtraArrowheadAfterEdgeLabel(sourceText));
|
||||||
|
|
||||||
|
addCandidate(appendMissingEnds(sourceText));
|
||||||
|
|
||||||
|
const normalizedQuotes = normalizeSmartQuotes(sourceText);
|
||||||
|
addCandidate(normalizedQuotes === sourceText ? null : normalizedQuotes);
|
||||||
|
}
|
||||||
|
|
||||||
|
return candidates;
|
||||||
|
};
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
formatMermaidParseErrorMessage,
|
||||||
|
getMermaidErrorLineNumber,
|
||||||
|
getMermaidInactiveParticipant,
|
||||||
|
getMermaidSyntaxErrorGuidance,
|
||||||
|
isMermaidAutoFixableError,
|
||||||
|
isMermaidParseSyntaxError,
|
||||||
|
isMermaidCaretLine,
|
||||||
|
} from "./mermaidError";
|
||||||
|
|
||||||
|
describe("formatMermaidParseErrorMessage", () => {
|
||||||
|
it("strips the noisy Expecting clause from Mermaid parse errors", () => {
|
||||||
|
const message = `Parse error on line 6:
|
||||||
|
... Control Protocol)"]x L3_UDP
|
||||||
|
----------------------^
|
||||||
|
Expecting 'SEMI', 'NEWLINE', 'SPACE', got 'NODE_STRING'`;
|
||||||
|
|
||||||
|
expect(formatMermaidParseErrorMessage(message)).toBe(`Parse error on line 6:
|
||||||
|
... Control Protocol)"]x L3_UDP
|
||||||
|
----------------------^`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps Mermaid parse errors unchanged when no Expecting clause exists", () => {
|
||||||
|
const message = `Parse error on line 3:
|
||||||
|
... some snippet
|
||||||
|
----^`;
|
||||||
|
|
||||||
|
expect(formatMermaidParseErrorMessage(message)).toBe(message);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not modify non-Mermaid parse messages", () => {
|
||||||
|
const message =
|
||||||
|
"Unexpected token while parsing JSON. Expecting value at position 10.";
|
||||||
|
|
||||||
|
expect(formatMermaidParseErrorMessage(message)).toBe(message);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("isMermaidCaretLine", () => {
|
||||||
|
it("returns true for Mermaid caret lines", () => {
|
||||||
|
expect(isMermaidCaretLine("-----------------------^")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns false for regular lines", () => {
|
||||||
|
expect(isMermaidCaretLine(`... Control Protocol)"]x`)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("isMermaidParseSyntaxError", () => {
|
||||||
|
it("returns true for Mermaid parser syntax errors", () => {
|
||||||
|
expect(isMermaidParseSyntaxError("Parse error on line 6: ...")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns true for Mermaid lexical syntax errors", () => {
|
||||||
|
expect(
|
||||||
|
isMermaidParseSyntaxError("Lexical error on line 2. Unrecognized text."),
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns false for non-parse errors", () => {
|
||||||
|
expect(isMermaidParseSyntaxError("Network error")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("isMermaidAutoFixableError", () => {
|
||||||
|
it("returns true for Mermaid parser syntax errors", () => {
|
||||||
|
expect(isMermaidAutoFixableError("Parse error on line 6: ...")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns true for inactive participant runtime errors", () => {
|
||||||
|
expect(
|
||||||
|
isMermaidAutoFixableError(
|
||||||
|
"Trying to inactivate an inactive participant (QA)",
|
||||||
|
),
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns false for non-fixable errors", () => {
|
||||||
|
expect(isMermaidAutoFixableError("Network error")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("getMermaidInactiveParticipant", () => {
|
||||||
|
it("extracts the participant id from inactive participant errors", () => {
|
||||||
|
expect(
|
||||||
|
getMermaidInactiveParticipant(
|
||||||
|
"Trying to inactivate an inactive participant (QA)",
|
||||||
|
),
|
||||||
|
).toBe("QA");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns null for unrelated errors", () => {
|
||||||
|
expect(
|
||||||
|
getMermaidInactiveParticipant("Parse error on line 3: ..."),
|
||||||
|
).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("getMermaidErrorLineNumber", () => {
|
||||||
|
it("extracts line number from parse error format", () => {
|
||||||
|
expect(getMermaidErrorLineNumber("Parse error on line 6: ...")).toBe(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("extracts line number from lexical error format", () => {
|
||||||
|
expect(
|
||||||
|
getMermaidErrorLineNumber("Lexical error on line 2. Unrecognized text."),
|
||||||
|
).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns null for messages without Mermaid line details", () => {
|
||||||
|
expect(getMermaidErrorLineNumber("Network error")).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("infers line from inactive participant errors when source text is provided", () => {
|
||||||
|
const sourceText = `sequenceDiagram
|
||||||
|
participant QA
|
||||||
|
deactivate QA
|
||||||
|
QA->>QA: Verifies Fix
|
||||||
|
deactivate QA`;
|
||||||
|
|
||||||
|
expect(
|
||||||
|
getMermaidErrorLineNumber(
|
||||||
|
"Trying to inactivate an inactive participant (QA)",
|
||||||
|
sourceText,
|
||||||
|
),
|
||||||
|
).toBe(5);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("getMermaidSyntaxErrorGuidance", () => {
|
||||||
|
it("returns summary and likely causes for Mermaid parse errors", () => {
|
||||||
|
const message = `Parse error on line 6:
|
||||||
|
... Control Protocol)"]x
|
||||||
|
----------------------^`;
|
||||||
|
|
||||||
|
const source = `graph TD
|
||||||
|
subgraph Layers["X"]
|
||||||
|
L3_TCP["TCP (Transmission Control Protocol)"]x`;
|
||||||
|
|
||||||
|
expect(getMermaidSyntaxErrorGuidance(message, source)).toEqual({
|
||||||
|
summary: "Syntax error near line 6.",
|
||||||
|
likelyCauses: expect.arrayContaining([
|
||||||
|
"A block is missing an `end` statement.",
|
||||||
|
]),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns null for non-parse errors", () => {
|
||||||
|
expect(
|
||||||
|
getMermaidSyntaxErrorGuidance("Network error", "graph TD"),
|
||||||
|
).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
const MERMAID_SYNTAX_ERROR_LINE = /(?:Parse|Lexical) error on line (\d+)[.:]/i;
|
||||||
|
const MERMAID_INACTIVE_PARTICIPANT_ERROR =
|
||||||
|
/Trying to inactivate an inactive participant \((.+)\)/i;
|
||||||
|
const MERMAID_CARET_LINE = /^\s*-+\^\s*$/;
|
||||||
|
|
||||||
|
export const isMermaidParseSyntaxError = (message: string) =>
|
||||||
|
MERMAID_SYNTAX_ERROR_LINE.test(message);
|
||||||
|
|
||||||
|
export const isMermaidAutoFixableError = (message: string) =>
|
||||||
|
isMermaidParseSyntaxError(message) ||
|
||||||
|
MERMAID_INACTIVE_PARTICIPANT_ERROR.test(message);
|
||||||
|
|
||||||
|
export const isMermaidCaretLine = (line: string) =>
|
||||||
|
MERMAID_CARET_LINE.test(line);
|
||||||
|
|
||||||
|
export const getMermaidInactiveParticipant = (
|
||||||
|
message: string,
|
||||||
|
): string | null => {
|
||||||
|
const match = message.match(MERMAID_INACTIVE_PARTICIPANT_ERROR);
|
||||||
|
if (!match?.[1]) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return match[1].trim();
|
||||||
|
};
|
||||||
|
|
||||||
|
const escapeRegExp = (value: string) =>
|
||||||
|
value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
|
|
||||||
|
const getInactiveParticipantLineNumber = (
|
||||||
|
message: string,
|
||||||
|
sourceText: string,
|
||||||
|
): number | null => {
|
||||||
|
const participant = getMermaidInactiveParticipant(message);
|
||||||
|
if (!participant) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const deactivatePattern = new RegExp(
|
||||||
|
`^\\s*deactivate\\s+${escapeRegExp(participant)}(?:\\s+%%.*)?\\s*$`,
|
||||||
|
);
|
||||||
|
const lines = sourceText.split(/\r?\n/);
|
||||||
|
for (let index = lines.length - 1; index >= 0; index--) {
|
||||||
|
if (deactivatePattern.test(lines[index])) {
|
||||||
|
return index + 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getMermaidErrorLineNumber = (
|
||||||
|
message: string,
|
||||||
|
sourceText?: string,
|
||||||
|
): number | null => {
|
||||||
|
const match = message.match(MERMAID_SYNTAX_ERROR_LINE);
|
||||||
|
if (!match) {
|
||||||
|
if (!sourceText) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return getInactiveParticipantLineNumber(message, sourceText);
|
||||||
|
}
|
||||||
|
return Number.parseInt(match[1], 10);
|
||||||
|
};
|
||||||
|
|
||||||
|
const countMatches = (text: string, re: RegExp) =>
|
||||||
|
(text.match(re) || []).length;
|
||||||
|
|
||||||
|
export const getMermaidSyntaxErrorGuidance = (
|
||||||
|
message: string,
|
||||||
|
sourceText?: string,
|
||||||
|
): { summary: string; likelyCauses: string[] } | null => {
|
||||||
|
if (!isMermaidParseSyntaxError(message)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const errorLine = getMermaidErrorLineNumber(message, sourceText);
|
||||||
|
const summary = errorLine
|
||||||
|
? `Syntax error near line ${errorLine}.`
|
||||||
|
: "Syntax error in Mermaid diagram.";
|
||||||
|
|
||||||
|
const likelyCauses: string[] = [];
|
||||||
|
|
||||||
|
if (sourceText) {
|
||||||
|
const openBrackets = countMatches(sourceText, /\[/g);
|
||||||
|
const closeBrackets = countMatches(sourceText, /\]/g);
|
||||||
|
if (openBrackets !== closeBrackets) {
|
||||||
|
likelyCauses.push("Unbalanced square brackets in a node label.");
|
||||||
|
}
|
||||||
|
|
||||||
|
const openParens = countMatches(sourceText, /\(/g);
|
||||||
|
const closeParens = countMatches(sourceText, /\)/g);
|
||||||
|
if (openParens !== closeParens) {
|
||||||
|
likelyCauses.push("Unbalanced parentheses in a node shape.");
|
||||||
|
}
|
||||||
|
|
||||||
|
const openBraces = countMatches(sourceText, /\{/g);
|
||||||
|
const closeBraces = countMatches(sourceText, /\}/g);
|
||||||
|
if (openBraces !== closeBraces) {
|
||||||
|
likelyCauses.push("Unbalanced braces in a decision node.");
|
||||||
|
}
|
||||||
|
|
||||||
|
const subgraphCount = countMatches(sourceText, /^\s*subgraph\b/gm);
|
||||||
|
const endCount = countMatches(sourceText, /^\s*end\s*$/gm);
|
||||||
|
if (subgraphCount > endCount) {
|
||||||
|
likelyCauses.push("A block is missing an `end` statement.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (/got 'NODE_STRING'/.test(message) || /got 'PS'/.test(message)) {
|
||||||
|
likelyCauses.push(
|
||||||
|
"An extra character/token may appear after a node or label definition.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (likelyCauses.length === 0) {
|
||||||
|
likelyCauses.push(
|
||||||
|
"A node or edge line is malformed (missing/extra delimiters).",
|
||||||
|
);
|
||||||
|
likelyCauses.push("A block (`subgraph`, `class`, etc.) may be incomplete.");
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
summary,
|
||||||
|
likelyCauses: [...new Set(likelyCauses)],
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const formatMermaidParseErrorMessage = (message: string) => {
|
||||||
|
if (!isMermaidParseSyntaxError(message)) {
|
||||||
|
return message;
|
||||||
|
}
|
||||||
|
|
||||||
|
return message.replace(/\n\s*Expecting[\s\S]*$/, "").trimEnd();
|
||||||
|
};
|
||||||
@@ -1,35 +1,51 @@
|
|||||||
@use "../css/variables.module" as *;
|
|
||||||
|
|
||||||
.excalidraw {
|
.excalidraw {
|
||||||
.Toast {
|
.Toast {
|
||||||
$closeButtonSize: 1.2rem;
|
$closeButtonSize: 1.2rem;
|
||||||
$closeButtonPadding: 0.4rem;
|
$closeButtonPadding: 0.4rem;
|
||||||
|
|
||||||
animation: fade-in 0.5s;
|
animation: Toast-fade-in 0.5s;
|
||||||
background-color: var(--button-gray-1);
|
min-width: 220px;
|
||||||
border-radius: 4px;
|
max-width: min(360px, calc(100vw - 32px));
|
||||||
bottom: 10px;
|
border-radius: var(--border-radius-lg);
|
||||||
|
border: 1px solid var(--default-border-color);
|
||||||
|
background-color: var(--island-bg-color);
|
||||||
|
color: var(--text-primary-color);
|
||||||
|
padding: 0.5rem 0.75rem;
|
||||||
|
box-shadow: 0 0 0 1px var(--color-surface-lowest);
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
cursor: default;
|
cursor: default;
|
||||||
left: 50%;
|
pointer-events: none;
|
||||||
margin-left: -150px;
|
|
||||||
padding: 4px 0;
|
|
||||||
position: absolute;
|
|
||||||
text-align: center;
|
|
||||||
width: 300px;
|
|
||||||
z-index: 999999;
|
|
||||||
|
|
||||||
.Toast__message {
|
.Toast__message {
|
||||||
|
font-family: var(--ui-font);
|
||||||
|
font-size: 0.75rem;
|
||||||
|
line-height: 1.25rem;
|
||||||
|
text-align: center;
|
||||||
padding: 0 $closeButtonSize + ($closeButtonPadding);
|
padding: 0 $closeButtonSize + ($closeButtonPadding);
|
||||||
color: var(--popup-text-color);
|
|
||||||
white-space: pre-wrap;
|
white-space: pre-wrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.Toast__progress-bar {
|
||||||
|
margin-top: 0.35rem;
|
||||||
|
width: 100%;
|
||||||
|
height: 4px;
|
||||||
|
border-radius: 999px;
|
||||||
|
background-color: var(--button-gray-2);
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.Toast__progress-bar-fill {
|
||||||
|
height: 100%;
|
||||||
|
border-radius: inherit;
|
||||||
|
background-color: var(--color-primary);
|
||||||
|
}
|
||||||
|
|
||||||
.close {
|
.close {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
top: 0;
|
top: 0;
|
||||||
right: 0;
|
right: 0;
|
||||||
padding: $closeButtonPadding;
|
padding: $closeButtonPadding;
|
||||||
|
pointer-events: auto;
|
||||||
|
|
||||||
.ToolIcon__icon {
|
.ToolIcon__icon {
|
||||||
width: $closeButtonSize;
|
width: $closeButtonSize;
|
||||||
@@ -38,7 +54,7 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@keyframes fade-in {
|
@keyframes Toast-fade-in {
|
||||||
from {
|
from {
|
||||||
opacity: 0;
|
opacity: 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,11 +5,22 @@ import { ToolButton } from "./ToolButton";
|
|||||||
|
|
||||||
import "./Toast.scss";
|
import "./Toast.scss";
|
||||||
|
|
||||||
import type { CSSProperties } from "react";
|
import type { CSSProperties, ReactNode } from "react";
|
||||||
|
|
||||||
const DEFAULT_TOAST_TIMEOUT = 5000;
|
const DEFAULT_TOAST_TIMEOUT = 5000;
|
||||||
|
|
||||||
export const Toast = ({
|
const ProgressBar = ({ progress }: { progress: number }) => (
|
||||||
|
<div className="Toast__progress-bar">
|
||||||
|
<div
|
||||||
|
className="Toast__progress-bar-fill"
|
||||||
|
style={{
|
||||||
|
width: `${Math.min(5, Math.round(progress * 100))}%`,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
const ToastComponent = ({
|
||||||
message,
|
message,
|
||||||
onClose,
|
onClose,
|
||||||
closable = false,
|
closable = false,
|
||||||
@@ -17,7 +28,7 @@ export const Toast = ({
|
|||||||
duration = DEFAULT_TOAST_TIMEOUT,
|
duration = DEFAULT_TOAST_TIMEOUT,
|
||||||
style,
|
style,
|
||||||
}: {
|
}: {
|
||||||
message: string;
|
message: ReactNode;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
closable?: boolean;
|
closable?: boolean;
|
||||||
duration?: number;
|
duration?: number;
|
||||||
@@ -47,11 +58,12 @@ export const Toast = ({
|
|||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
className="Toast"
|
className="Toast"
|
||||||
|
role="status"
|
||||||
onMouseEnter={onMouseEnter}
|
onMouseEnter={onMouseEnter}
|
||||||
onMouseLeave={onMouseLeave}
|
onMouseLeave={onMouseLeave}
|
||||||
style={style}
|
style={style}
|
||||||
>
|
>
|
||||||
<p className="Toast__message">{message}</p>
|
<div className="Toast__message">{message}</div>
|
||||||
{closable && (
|
{closable && (
|
||||||
<ToolButton
|
<ToolButton
|
||||||
icon={CloseIcon}
|
icon={CloseIcon}
|
||||||
@@ -64,3 +76,5 @@ export const Toast = ({
|
|||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const Toast = Object.assign(ToastComponent, { ProgressBar });
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import {
|
|||||||
sceneCoordsToViewportCoords,
|
sceneCoordsToViewportCoords,
|
||||||
type EditorInterface,
|
type EditorInterface,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
import { AnimationController } from "@excalidraw/excalidraw/renderer/animation";
|
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
InteractiveCanvasRenderConfig,
|
InteractiveCanvasRenderConfig,
|
||||||
@@ -24,6 +23,8 @@ import type {
|
|||||||
import { t } from "../../i18n";
|
import { t } from "../../i18n";
|
||||||
import { renderInteractiveScene } from "../../renderer/interactiveScene";
|
import { renderInteractiveScene } from "../../renderer/interactiveScene";
|
||||||
|
|
||||||
|
import { AnimationController } from "../../renderer/animation";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
AppClassProperties,
|
AppClassProperties,
|
||||||
AppState,
|
AppState,
|
||||||
@@ -202,9 +203,11 @@ const InteractiveCanvas = (props: InteractiveCanvasProps) => {
|
|||||||
style={{
|
style={{
|
||||||
width: props.appState.width,
|
width: props.appState.width,
|
||||||
height: props.appState.height,
|
height: props.appState.height,
|
||||||
cursor: props.appState.viewModeEnabled
|
cursor:
|
||||||
? CURSOR_TYPE.GRAB
|
props.appState.viewModeEnabled &&
|
||||||
: CURSOR_TYPE.AUTO,
|
props.appState.activeTool.type !== "laser"
|
||||||
|
? CURSOR_TYPE.GRAB
|
||||||
|
: CURSOR_TYPE.AUTO,
|
||||||
}}
|
}}
|
||||||
width={props.appState.width * props.scale}
|
width={props.appState.width * props.scale}
|
||||||
height={props.appState.height * props.scale}
|
height={props.appState.height * props.scale}
|
||||||
@@ -233,6 +236,7 @@ const getRelevantAppStateProps = (
|
|||||||
width: appState.width,
|
width: appState.width,
|
||||||
height: appState.height,
|
height: appState.height,
|
||||||
viewModeEnabled: appState.viewModeEnabled,
|
viewModeEnabled: appState.viewModeEnabled,
|
||||||
|
activeTool: appState.activeTool,
|
||||||
openDialog: appState.openDialog,
|
openDialog: appState.openDialog,
|
||||||
editingGroupId: appState.editingGroupId,
|
editingGroupId: appState.editingGroupId,
|
||||||
selectedElementIds: appState.selectedElementIds,
|
selectedElementIds: appState.selectedElementIds,
|
||||||
@@ -246,6 +250,7 @@ const getRelevantAppStateProps = (
|
|||||||
multiElement: appState.multiElement,
|
multiElement: appState.multiElement,
|
||||||
newElement: appState.newElement,
|
newElement: appState.newElement,
|
||||||
isBindingEnabled: appState.isBindingEnabled,
|
isBindingEnabled: appState.isBindingEnabled,
|
||||||
|
isMidpointSnappingEnabled: appState.isMidpointSnappingEnabled,
|
||||||
suggestedBinding: appState.suggestedBinding,
|
suggestedBinding: appState.suggestedBinding,
|
||||||
isRotating: appState.isRotating,
|
isRotating: appState.isRotating,
|
||||||
elementsToHighlight: appState.elementsToHighlight,
|
elementsToHighlight: appState.elementsToHighlight,
|
||||||
@@ -262,6 +267,7 @@ const getRelevantAppStateProps = (
|
|||||||
frameRendering: appState.frameRendering,
|
frameRendering: appState.frameRendering,
|
||||||
shouldCacheIgnoreZoom: appState.shouldCacheIgnoreZoom,
|
shouldCacheIgnoreZoom: appState.shouldCacheIgnoreZoom,
|
||||||
exportScale: appState.exportScale,
|
exportScale: appState.exportScale,
|
||||||
|
currentItemArrowType: appState.currentItemArrowType,
|
||||||
});
|
});
|
||||||
|
|
||||||
const areEqual = (
|
const areEqual = (
|
||||||
|
|||||||
@@ -181,6 +181,21 @@
|
|||||||
box-shadow: 0 0 0 1px var(--color-brand-active);
|
box-shadow: 0 0 0 1px var(--color-brand-active);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
&[disabled] {
|
||||||
|
cursor: not-allowed;
|
||||||
|
opacity: 0.5;
|
||||||
|
pointer-events: none;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:active {
|
||||||
|
background-color: transparent;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
svg {
|
svg {
|
||||||
width: 1rem;
|
width: 1rem;
|
||||||
height: 1rem;
|
height: 1rem;
|
||||||
|
|||||||
@@ -9,7 +9,9 @@ import {
|
|||||||
actionLoadScene,
|
actionLoadScene,
|
||||||
actionSaveToActiveFile,
|
actionSaveToActiveFile,
|
||||||
actionShortcuts,
|
actionShortcuts,
|
||||||
|
actionToggleArrowBinding,
|
||||||
actionToggleGridMode,
|
actionToggleGridMode,
|
||||||
|
actionToggleMidpointSnapping,
|
||||||
actionToggleObjectsSnapMode,
|
actionToggleObjectsSnapMode,
|
||||||
actionToggleSearchMenu,
|
actionToggleSearchMenu,
|
||||||
actionToggleStats,
|
actionToggleStats,
|
||||||
@@ -443,6 +445,40 @@ const PreferencesToggleSnapModeItem = () => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const PreferencesToggleArrowBindingItem = () => {
|
||||||
|
const { t } = useI18n();
|
||||||
|
const actionManager = useExcalidrawActionManager();
|
||||||
|
const appState = useUIAppState();
|
||||||
|
return (
|
||||||
|
<DropdownMenuItemCheckbox
|
||||||
|
checked={appState.bindingPreference === "enabled"}
|
||||||
|
onSelect={(event) => {
|
||||||
|
actionManager.executeAction(actionToggleArrowBinding);
|
||||||
|
event.preventDefault();
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{t("labels.arrowBinding")}
|
||||||
|
</DropdownMenuItemCheckbox>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const PreferencesToggleMidpointSnappingItem = () => {
|
||||||
|
const { t } = useI18n();
|
||||||
|
const actionManager = useExcalidrawActionManager();
|
||||||
|
const appState = useUIAppState();
|
||||||
|
return (
|
||||||
|
<DropdownMenuItemCheckbox
|
||||||
|
checked={appState.isMidpointSnappingEnabled}
|
||||||
|
onSelect={(event) => {
|
||||||
|
actionManager.executeAction(actionToggleMidpointSnapping);
|
||||||
|
event.preventDefault();
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{t("labels.midpointSnapping")}
|
||||||
|
</DropdownMenuItemCheckbox>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
export const PreferencesToggleGridModeItem = () => {
|
export const PreferencesToggleGridModeItem = () => {
|
||||||
const { t } = useI18n();
|
const { t } = useI18n();
|
||||||
const actionManager = useExcalidrawActionManager();
|
const actionManager = useExcalidrawActionManager();
|
||||||
@@ -538,6 +574,8 @@ export const Preferences = ({
|
|||||||
<PreferencesToggleZenModeItem />
|
<PreferencesToggleZenModeItem />
|
||||||
<PreferencesToggleViewModeItem />
|
<PreferencesToggleViewModeItem />
|
||||||
<PreferencesToggleElementPropertiesItem />
|
<PreferencesToggleElementPropertiesItem />
|
||||||
|
<PreferencesToggleArrowBindingItem />
|
||||||
|
<PreferencesToggleMidpointSnappingItem />
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
{additionalItems}
|
{additionalItems}
|
||||||
@@ -548,6 +586,8 @@ export const Preferences = ({
|
|||||||
|
|
||||||
Preferences.ToggleToolLock = PreferencesToggleToolLockItem;
|
Preferences.ToggleToolLock = PreferencesToggleToolLockItem;
|
||||||
Preferences.ToggleSnapMode = PreferencesToggleSnapModeItem;
|
Preferences.ToggleSnapMode = PreferencesToggleSnapModeItem;
|
||||||
|
Preferences.ToggleArrowBinding = PreferencesToggleArrowBindingItem;
|
||||||
|
Preferences.ToggleMidpointSnapping = PreferencesToggleMidpointSnappingItem;
|
||||||
Preferences.ToggleGridMode = PreferencesToggleGridModeItem;
|
Preferences.ToggleGridMode = PreferencesToggleGridModeItem;
|
||||||
Preferences.ToggleZenMode = PreferencesToggleZenModeItem;
|
Preferences.ToggleZenMode = PreferencesToggleZenModeItem;
|
||||||
Preferences.ToggleViewMode = PreferencesToggleViewModeItem;
|
Preferences.ToggleViewMode = PreferencesToggleViewModeItem;
|
||||||
|
|||||||
@@ -11,17 +11,28 @@ import {
|
|||||||
TextIcon,
|
TextIcon,
|
||||||
ImageIcon,
|
ImageIcon,
|
||||||
EraserIcon,
|
EraserIcon,
|
||||||
|
laserPointerToolIcon,
|
||||||
|
handIcon,
|
||||||
} from "./icons";
|
} from "./icons";
|
||||||
|
|
||||||
import type { AppClassProperties } from "../types";
|
import type { AppClassProperties } from "../types";
|
||||||
|
|
||||||
export const SHAPES = [
|
export const SHAPES = [
|
||||||
|
{
|
||||||
|
icon: handIcon,
|
||||||
|
value: "hand",
|
||||||
|
key: KEYS.H,
|
||||||
|
numericKey: null,
|
||||||
|
fillable: false,
|
||||||
|
toolbar: true,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
icon: SelectionIcon,
|
icon: SelectionIcon,
|
||||||
value: "selection",
|
value: "selection",
|
||||||
key: KEYS.V,
|
key: KEYS.V,
|
||||||
numericKey: KEYS["1"],
|
numericKey: KEYS["1"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: RectangleIcon,
|
icon: RectangleIcon,
|
||||||
@@ -29,6 +40,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.R,
|
key: KEYS.R,
|
||||||
numericKey: KEYS["2"],
|
numericKey: KEYS["2"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: DiamondIcon,
|
icon: DiamondIcon,
|
||||||
@@ -36,6 +48,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.D,
|
key: KEYS.D,
|
||||||
numericKey: KEYS["3"],
|
numericKey: KEYS["3"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: EllipseIcon,
|
icon: EllipseIcon,
|
||||||
@@ -43,6 +56,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.O,
|
key: KEYS.O,
|
||||||
numericKey: KEYS["4"],
|
numericKey: KEYS["4"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: ArrowIcon,
|
icon: ArrowIcon,
|
||||||
@@ -50,6 +64,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.A,
|
key: KEYS.A,
|
||||||
numericKey: KEYS["5"],
|
numericKey: KEYS["5"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: LineIcon,
|
icon: LineIcon,
|
||||||
@@ -57,6 +72,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.L,
|
key: KEYS.L,
|
||||||
numericKey: KEYS["6"],
|
numericKey: KEYS["6"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: FreedrawIcon,
|
icon: FreedrawIcon,
|
||||||
@@ -64,6 +80,7 @@ export const SHAPES = [
|
|||||||
key: [KEYS.P, KEYS.X],
|
key: [KEYS.P, KEYS.X],
|
||||||
numericKey: KEYS["7"],
|
numericKey: KEYS["7"],
|
||||||
fillable: false,
|
fillable: false,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: TextIcon,
|
icon: TextIcon,
|
||||||
@@ -71,6 +88,7 @@ export const SHAPES = [
|
|||||||
key: KEYS.T,
|
key: KEYS.T,
|
||||||
numericKey: KEYS["8"],
|
numericKey: KEYS["8"],
|
||||||
fillable: false,
|
fillable: false,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: ImageIcon,
|
icon: ImageIcon,
|
||||||
@@ -78,6 +96,7 @@ export const SHAPES = [
|
|||||||
key: null,
|
key: null,
|
||||||
numericKey: KEYS["9"],
|
numericKey: KEYS["9"],
|
||||||
fillable: false,
|
fillable: false,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: EraserIcon,
|
icon: EraserIcon,
|
||||||
@@ -85,6 +104,15 @@ export const SHAPES = [
|
|||||||
key: KEYS.E,
|
key: KEYS.E,
|
||||||
numericKey: KEYS["0"],
|
numericKey: KEYS["0"],
|
||||||
fillable: false,
|
fillable: false,
|
||||||
|
toolbar: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
icon: laserPointerToolIcon,
|
||||||
|
value: "laser",
|
||||||
|
key: KEYS.K,
|
||||||
|
numericKey: null,
|
||||||
|
fillable: false,
|
||||||
|
toolbar: false,
|
||||||
},
|
},
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
@@ -97,6 +125,7 @@ export const getToolbarTools = (app: AppClassProperties) => {
|
|||||||
key: KEYS.V,
|
key: KEYS.V,
|
||||||
numericKey: KEYS["1"],
|
numericKey: KEYS["1"],
|
||||||
fillable: true,
|
fillable: true,
|
||||||
|
toolbar: true,
|
||||||
},
|
},
|
||||||
...SHAPES.slice(1),
|
...SHAPES.slice(1),
|
||||||
] as const)
|
] as const)
|
||||||
|
|||||||
@@ -500,6 +500,26 @@ body.excalidraw-cursor-resize * {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.floating-status-stack {
|
||||||
|
position: absolute;
|
||||||
|
left: 50%;
|
||||||
|
bottom: 30px;
|
||||||
|
transform: translateX(-50%);
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
pointer-events: none;
|
||||||
|
|
||||||
|
.scroll-back-to-content {
|
||||||
|
position: static;
|
||||||
|
left: auto;
|
||||||
|
bottom: auto;
|
||||||
|
transform: none;
|
||||||
|
pointer-events: var(--ui-pointerEvents);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.help-icon {
|
.help-icon {
|
||||||
@include outlineButtonStyles;
|
@include outlineButtonStyles;
|
||||||
@include filledButtonOnCanvas;
|
@include filledButtonOnCanvas;
|
||||||
|
|||||||
@@ -27,8 +27,6 @@ import {
|
|||||||
|
|
||||||
import type { AppState, DataURL, LibraryItem } from "../types";
|
import type { AppState, DataURL, LibraryItem } from "../types";
|
||||||
|
|
||||||
import type { FileSystemHandle } from "browser-fs-access";
|
|
||||||
import type { SchemaMigrationRegistry } from "./schema";
|
|
||||||
import type { ImportedLibraryData } from "./types";
|
import type { ImportedLibraryData } from "./types";
|
||||||
|
|
||||||
const parseFileContents = async (blob: Blob | File): Promise<string> => {
|
const parseFileContents = async (blob: Blob | File): Promise<string> => {
|
||||||
@@ -105,7 +103,7 @@ export const getMimeType = (blob: Blob | string): string => {
|
|||||||
return "";
|
return "";
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getFileHandleType = (handle: FileSystemHandle | null) => {
|
export const getFileHandleType = (handle: FileSystemFileHandle | null) => {
|
||||||
if (!handle) {
|
if (!handle) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -119,7 +117,9 @@ export const isImageFileHandleType = (
|
|||||||
return type === "png" || type === "svg";
|
return type === "png" || type === "svg";
|
||||||
};
|
};
|
||||||
|
|
||||||
export const isImageFileHandle = (handle: FileSystemHandle | null) => {
|
export const isImageFileHandle = (
|
||||||
|
handle: FileSystemFileHandle | null,
|
||||||
|
): handle is FileSystemFileHandle => {
|
||||||
const type = getFileHandleType(handle);
|
const type = getFileHandleType(handle);
|
||||||
return type === "png" || type === "svg";
|
return type === "png" || type === "svg";
|
||||||
};
|
};
|
||||||
@@ -140,9 +140,8 @@ export const loadSceneOrLibraryFromBlob = async (
|
|||||||
/** @see restore.localAppState */
|
/** @see restore.localAppState */
|
||||||
localAppState: AppState | null,
|
localAppState: AppState | null,
|
||||||
localElements: readonly ExcalidrawElement[] | null,
|
localElements: readonly ExcalidrawElement[] | null,
|
||||||
/** FileSystemHandle. Defaults to `blob.handle` if defined, otherwise null. */
|
/** FileSystemFileHandle. Defaults to `blob.handle` if defined, otherwise null. */
|
||||||
fileHandle?: FileSystemHandle | null,
|
fileHandle?: FileSystemFileHandle | null,
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
) => {
|
) => {
|
||||||
const contents = await parseFileContents(blob);
|
const contents = await parseFileContents(blob);
|
||||||
let data;
|
let data;
|
||||||
@@ -165,7 +164,6 @@ export const loadSceneOrLibraryFromBlob = async (
|
|||||||
elements: restoreElements(data.elements, localElements, {
|
elements: restoreElements(data.elements, localElements, {
|
||||||
repairBindings: true,
|
repairBindings: true,
|
||||||
deleteInvisibleElements: true,
|
deleteInvisibleElements: true,
|
||||||
schemaMigrationRegistry,
|
|
||||||
}),
|
}),
|
||||||
appState: restoreAppState(
|
appState: restoreAppState(
|
||||||
{
|
{
|
||||||
@@ -201,16 +199,14 @@ export const loadFromBlob = async (
|
|||||||
/** @see restore.localAppState */
|
/** @see restore.localAppState */
|
||||||
localAppState: AppState | null,
|
localAppState: AppState | null,
|
||||||
localElements: readonly ExcalidrawElement[] | null,
|
localElements: readonly ExcalidrawElement[] | null,
|
||||||
/** FileSystemHandle. Defaults to `blob.handle` if defined, otherwise null. */
|
/** FileSystemFileHandle. Defaults to `blob.handle` if defined, otherwise null. */
|
||||||
fileHandle?: FileSystemHandle | null,
|
fileHandle?: FileSystemFileHandle | null,
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
) => {
|
) => {
|
||||||
const ret = await loadSceneOrLibraryFromBlob(
|
const ret = await loadSceneOrLibraryFromBlob(
|
||||||
blob,
|
blob,
|
||||||
localAppState,
|
localAppState,
|
||||||
localElements,
|
localElements,
|
||||||
fileHandle,
|
fileHandle,
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
);
|
||||||
if (ret.type !== MIME_TYPES.excalidraw) {
|
if (ret.type !== MIME_TYPES.excalidraw) {
|
||||||
throw new Error("Error: invalid file");
|
throw new Error("Error: invalid file");
|
||||||
@@ -221,28 +217,20 @@ export const loadFromBlob = async (
|
|||||||
export const parseLibraryJSON = (
|
export const parseLibraryJSON = (
|
||||||
json: string,
|
json: string,
|
||||||
defaultStatus: LibraryItem["status"] = "unpublished",
|
defaultStatus: LibraryItem["status"] = "unpublished",
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
) => {
|
) => {
|
||||||
const data: ImportedLibraryData | undefined = JSON.parse(json);
|
const data: ImportedLibraryData | undefined = JSON.parse(json);
|
||||||
if (!isValidLibrary(data)) {
|
if (!isValidLibrary(data)) {
|
||||||
throw new Error("Invalid library");
|
throw new Error("Invalid library");
|
||||||
}
|
}
|
||||||
const libraryItems = data.libraryItems || data.library;
|
const libraryItems = data.libraryItems || data.library;
|
||||||
return restoreLibraryItems(libraryItems, defaultStatus, {
|
return restoreLibraryItems(libraryItems, defaultStatus);
|
||||||
schemaMigrationRegistry,
|
|
||||||
});
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const loadLibraryFromBlob = async (
|
export const loadLibraryFromBlob = async (
|
||||||
blob: Blob,
|
blob: Blob,
|
||||||
defaultStatus: LibraryItem["status"] = "unpublished",
|
defaultStatus: LibraryItem["status"] = "unpublished",
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
) => {
|
) => {
|
||||||
return parseLibraryJSON(
|
return parseLibraryJSON(await parseFileContents(blob), defaultStatus);
|
||||||
await parseFileContents(blob),
|
|
||||||
defaultStatus,
|
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const canvasToBlob = async (
|
export const canvasToBlob = async (
|
||||||
@@ -405,7 +393,7 @@ export const ImageURLToFile = async (
|
|||||||
|
|
||||||
export const getFileHandle = async (
|
export const getFileHandle = async (
|
||||||
event: DragEvent | React.DragEvent | DataTransferItem,
|
event: DragEvent | React.DragEvent | DataTransferItem,
|
||||||
): Promise<FileSystemHandle | null> => {
|
): Promise<FileSystemFileHandle | null> => {
|
||||||
if (nativeFileSystemSupported) {
|
if (nativeFileSystemSupported) {
|
||||||
try {
|
try {
|
||||||
const dataTransferItem =
|
const dataTransferItem =
|
||||||
@@ -413,7 +401,7 @@ export const getFileHandle = async (
|
|||||||
? event
|
? event
|
||||||
: (event as DragEvent).dataTransfer?.items?.[0];
|
: (event as DragEvent).dataTransfer?.items?.[0];
|
||||||
|
|
||||||
const handle: FileSystemHandle | null =
|
const handle: FileSystemFileHandle | null =
|
||||||
(await (dataTransferItem as any).getAsFileSystemHandle()) || null;
|
(await (dataTransferItem as any).getAsFileSystemHandle()) || null;
|
||||||
|
|
||||||
return handle;
|
return handle;
|
||||||
|
|||||||
@@ -4,18 +4,12 @@ import {
|
|||||||
supported as nativeFileSystemSupported,
|
supported as nativeFileSystemSupported,
|
||||||
} from "browser-fs-access";
|
} from "browser-fs-access";
|
||||||
|
|
||||||
import { EVENT, MIME_TYPES, debounce } from "@excalidraw/common";
|
import { MIME_TYPES } from "@excalidraw/common";
|
||||||
|
|
||||||
import { AbortError } from "../errors";
|
|
||||||
|
|
||||||
import { normalizeFile } from "./blob";
|
import { normalizeFile } from "./blob";
|
||||||
|
|
||||||
import type { FileSystemHandle } from "browser-fs-access";
|
|
||||||
|
|
||||||
type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
|
type FILE_EXTENSION = Exclude<keyof typeof MIME_TYPES, "binary">;
|
||||||
|
|
||||||
const INPUT_CHANGE_INTERVAL_MS = 5000;
|
|
||||||
|
|
||||||
export const fileOpen = async <M extends boolean | undefined = false>(opts: {
|
export const fileOpen = async <M extends boolean | undefined = false>(opts: {
|
||||||
extensions?: FILE_EXTENSION[];
|
extensions?: FILE_EXTENSION[];
|
||||||
description: string;
|
description: string;
|
||||||
@@ -42,40 +36,6 @@ export const fileOpen = async <M extends boolean | undefined = false>(opts: {
|
|||||||
extensions,
|
extensions,
|
||||||
mimeTypes,
|
mimeTypes,
|
||||||
multiple: opts.multiple ?? false,
|
multiple: opts.multiple ?? false,
|
||||||
legacySetup: (resolve, reject, input) => {
|
|
||||||
const scheduleRejection = debounce(reject, INPUT_CHANGE_INTERVAL_MS);
|
|
||||||
const focusHandler = () => {
|
|
||||||
checkForFile();
|
|
||||||
document.addEventListener(EVENT.KEYUP, scheduleRejection);
|
|
||||||
document.addEventListener(EVENT.POINTER_UP, scheduleRejection);
|
|
||||||
scheduleRejection();
|
|
||||||
};
|
|
||||||
const checkForFile = () => {
|
|
||||||
// this hack might not work when expecting multiple files
|
|
||||||
if (input.files?.length) {
|
|
||||||
const ret = opts.multiple ? [...input.files] : input.files[0];
|
|
||||||
resolve(ret as RetType);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
requestAnimationFrame(() => {
|
|
||||||
window.addEventListener(EVENT.FOCUS, focusHandler);
|
|
||||||
});
|
|
||||||
const interval = window.setInterval(() => {
|
|
||||||
checkForFile();
|
|
||||||
}, INPUT_CHANGE_INTERVAL_MS);
|
|
||||||
return (rejectPromise) => {
|
|
||||||
clearInterval(interval);
|
|
||||||
scheduleRejection.cancel();
|
|
||||||
window.removeEventListener(EVENT.FOCUS, focusHandler);
|
|
||||||
document.removeEventListener(EVENT.KEYUP, scheduleRejection);
|
|
||||||
document.removeEventListener(EVENT.POINTER_UP, scheduleRejection);
|
|
||||||
if (rejectPromise) {
|
|
||||||
// so that something is shown in console if we need to debug this
|
|
||||||
console.warn("Opening the file was canceled (legacy-fs).");
|
|
||||||
rejectPromise(new AbortError());
|
|
||||||
}
|
|
||||||
};
|
|
||||||
},
|
|
||||||
});
|
});
|
||||||
|
|
||||||
if (Array.isArray(files)) {
|
if (Array.isArray(files)) {
|
||||||
@@ -95,8 +55,8 @@ export const fileSave = (
|
|||||||
extension: FILE_EXTENSION;
|
extension: FILE_EXTENSION;
|
||||||
mimeTypes?: string[];
|
mimeTypes?: string[];
|
||||||
description: string;
|
description: string;
|
||||||
/** existing FileSystemHandle */
|
/** existing FileSystemFileHandle */
|
||||||
fileHandle?: FileSystemHandle | null;
|
fileHandle?: FileSystemFileHandle | null;
|
||||||
},
|
},
|
||||||
) => {
|
) => {
|
||||||
return _fileSave(
|
return _fileSave(
|
||||||
@@ -108,8 +68,8 @@ export const fileSave = (
|
|||||||
mimeTypes: opts.mimeTypes,
|
mimeTypes: opts.mimeTypes,
|
||||||
},
|
},
|
||||||
opts.fileHandle,
|
opts.fileHandle,
|
||||||
|
false,
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export { nativeFileSystemSupported };
|
export { nativeFileSystemSupported };
|
||||||
export type { FileSystemHandle };
|
|
||||||
|
|||||||
@@ -33,8 +33,6 @@ import { canvasToBlob } from "./blob";
|
|||||||
import { fileSave } from "./filesystem";
|
import { fileSave } from "./filesystem";
|
||||||
import { serializeAsJSON } from "./json";
|
import { serializeAsJSON } from "./json";
|
||||||
|
|
||||||
import type { FileSystemHandle } from "./filesystem";
|
|
||||||
|
|
||||||
import type { ExportType } from "../scene/types";
|
import type { ExportType } from "../scene/types";
|
||||||
import type { AppState, BinaryFiles } from "../types";
|
import type { AppState, BinaryFiles } from "../types";
|
||||||
|
|
||||||
@@ -110,7 +108,7 @@ export const exportCanvas = async (
|
|||||||
viewBackgroundColor: string;
|
viewBackgroundColor: string;
|
||||||
/** filename, if applicable */
|
/** filename, if applicable */
|
||||||
name?: string;
|
name?: string;
|
||||||
fileHandle?: FileSystemHandle | null;
|
fileHandle?: FileSystemFileHandle | null;
|
||||||
exportingFrame: ExcalidrawFrameLikeElement | null;
|
exportingFrame: ExcalidrawFrameLikeElement | null;
|
||||||
},
|
},
|
||||||
) => {
|
) => {
|
||||||
|
|||||||
@@ -1,12 +1,13 @@
|
|||||||
import {
|
import {
|
||||||
DEFAULT_FILENAME,
|
|
||||||
EXPORT_DATA_TYPES,
|
EXPORT_DATA_TYPES,
|
||||||
getExportSource,
|
getExportSource,
|
||||||
MIME_TYPES,
|
MIME_TYPES,
|
||||||
VERSIONS,
|
VERSIONS,
|
||||||
} from "@excalidraw/common";
|
} from "@excalidraw/common";
|
||||||
|
|
||||||
import type { ExcalidrawElement } from "@excalidraw/element/types";
|
import type { ExcalidrawElement, NonDeleted } from "@excalidraw/element/types";
|
||||||
|
|
||||||
|
import type { MaybePromise } from "@excalidraw/common/utility-types";
|
||||||
|
|
||||||
import { cleanAppStateForExport, clearAppStateForDatabase } from "../appState";
|
import { cleanAppStateForExport, clearAppStateForDatabase } from "../appState";
|
||||||
|
|
||||||
@@ -14,7 +15,6 @@ import { isImageFileHandle, loadFromBlob } from "./blob";
|
|||||||
import { fileOpen, fileSave } from "./filesystem";
|
import { fileOpen, fileSave } from "./filesystem";
|
||||||
|
|
||||||
import type { AppState, BinaryFiles, LibraryItems } from "../types";
|
import type { AppState, BinaryFiles, LibraryItems } from "../types";
|
||||||
import type { SchemaMigrationRegistry } from "./schema";
|
|
||||||
import type {
|
import type {
|
||||||
ExportedDataState,
|
ExportedDataState,
|
||||||
ImportedDataState,
|
ImportedDataState,
|
||||||
@@ -22,6 +22,12 @@ import type {
|
|||||||
ImportedLibraryData,
|
ImportedLibraryData,
|
||||||
} from "./types";
|
} from "./types";
|
||||||
|
|
||||||
|
export type JSONExportData = {
|
||||||
|
elements: readonly NonDeleted<ExcalidrawElement>[];
|
||||||
|
appState: AppState;
|
||||||
|
files: BinaryFiles;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Strips out files which are only referenced by deleted elements
|
* Strips out files which are only referenced by deleted elements
|
||||||
*/
|
*/
|
||||||
@@ -68,33 +74,34 @@ export const serializeAsJSON = (
|
|||||||
return JSON.stringify(data, null, 2);
|
return JSON.stringify(data, null, 2);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const saveAsJSON = async (
|
export const saveAsJSON = async ({
|
||||||
elements: readonly ExcalidrawElement[],
|
data,
|
||||||
appState: AppState,
|
filename,
|
||||||
files: BinaryFiles,
|
fileHandle,
|
||||||
/** filename */
|
}: {
|
||||||
name: string = appState.name || DEFAULT_FILENAME,
|
data: MaybePromise<JSONExportData>;
|
||||||
) => {
|
filename: string;
|
||||||
const serialized = serializeAsJSON(elements, appState, files, "local");
|
fileHandle: AppState["fileHandle"];
|
||||||
const blob = new Blob([serialized], {
|
}) => {
|
||||||
type: MIME_TYPES.excalidraw,
|
const blob = Promise.resolve(data).then(({ elements, appState, files }) => {
|
||||||
|
const serialized = serializeAsJSON(elements, appState, files, "local");
|
||||||
|
return new Blob([serialized], {
|
||||||
|
type: MIME_TYPES.excalidraw,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
const fileHandle = await fileSave(blob, {
|
const savedFileHandle = await fileSave(blob, {
|
||||||
name,
|
name: filename,
|
||||||
extension: "excalidraw",
|
extension: "excalidraw",
|
||||||
description: "Excalidraw file",
|
description: "Excalidraw file",
|
||||||
fileHandle: isImageFileHandle(appState.fileHandle)
|
fileHandle: isImageFileHandle(fileHandle) ? null : fileHandle,
|
||||||
? null
|
|
||||||
: appState.fileHandle,
|
|
||||||
});
|
});
|
||||||
return { fileHandle };
|
return { fileHandle: savedFileHandle };
|
||||||
};
|
};
|
||||||
|
|
||||||
export const loadFromJSON = async (
|
export const loadFromJSON = async (
|
||||||
localAppState: AppState,
|
localAppState: AppState,
|
||||||
localElements: readonly ExcalidrawElement[] | null,
|
localElements: readonly ExcalidrawElement[] | null,
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
) => {
|
) => {
|
||||||
const file = await fileOpen({
|
const file = await fileOpen({
|
||||||
description: "Excalidraw files",
|
description: "Excalidraw files",
|
||||||
@@ -102,13 +109,7 @@ export const loadFromJSON = async (
|
|||||||
// gets resolved. Else, iOS users cannot open `.excalidraw` files.
|
// gets resolved. Else, iOS users cannot open `.excalidraw` files.
|
||||||
// extensions: ["json", "excalidraw", "png", "svg"],
|
// extensions: ["json", "excalidraw", "png", "svg"],
|
||||||
});
|
});
|
||||||
return loadFromBlob(
|
return loadFromBlob(file, localAppState, localElements, file.handle);
|
||||||
file,
|
|
||||||
localAppState,
|
|
||||||
localElements,
|
|
||||||
file.handle,
|
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const isValidExcalidrawData = (data?: {
|
export const isValidExcalidrawData = (data?: {
|
||||||
|
|||||||
@@ -35,7 +35,6 @@ import { loadLibraryFromBlob } from "./blob";
|
|||||||
import { restoreLibraryItems } from "./restore";
|
import { restoreLibraryItems } from "./restore";
|
||||||
|
|
||||||
import type App from "../components/App";
|
import type App from "../components/App";
|
||||||
import type { SchemaMigrationRegistry } from "./schema";
|
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
LibraryItems,
|
LibraryItems,
|
||||||
@@ -66,9 +65,9 @@ type LibraryUpdate = {
|
|||||||
updatedItems: Map<LibraryItem["id"], LibraryItem>;
|
updatedItems: Map<LibraryItem["id"], LibraryItem>;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LibraryPersistedData = {
|
// an object so that we can later add more properties to it without breaking,
|
||||||
libraryItems: LibraryItems;
|
// such as schema version
|
||||||
};
|
export type LibraryPersistedData = { libraryItems: LibraryItems };
|
||||||
|
|
||||||
const onLibraryUpdateEmitter = new Emitter<
|
const onLibraryUpdateEmitter = new Emitter<
|
||||||
[update: LibraryUpdate, libraryItems: LibraryItems]
|
[update: LibraryUpdate, libraryItems: LibraryItems]
|
||||||
@@ -100,9 +99,7 @@ export interface LibraryMigrationAdapter {
|
|||||||
* loads data from legacy data source. Returns `null` if no data is
|
* loads data from legacy data source. Returns `null` if no data is
|
||||||
* to be migrated.
|
* to be migrated.
|
||||||
*/
|
*/
|
||||||
load(): MaybePromise<{
|
load(): MaybePromise<{ libraryItems: LibraryItems_anyVersion } | null>;
|
||||||
libraryItems: LibraryItems_anyVersion;
|
|
||||||
} | null>;
|
|
||||||
|
|
||||||
/** clears entire storage afterwards */
|
/** clears entire storage afterwards */
|
||||||
clear(): MaybePromise<void>;
|
clear(): MaybePromise<void>;
|
||||||
@@ -317,15 +314,9 @@ class Library {
|
|||||||
let nextItems;
|
let nextItems;
|
||||||
|
|
||||||
if (source instanceof Blob) {
|
if (source instanceof Blob) {
|
||||||
nextItems = await loadLibraryFromBlob(
|
nextItems = await loadLibraryFromBlob(source, defaultStatus);
|
||||||
source,
|
|
||||||
defaultStatus,
|
|
||||||
this.app.getSchemaMigrationRegistry(),
|
|
||||||
);
|
|
||||||
} else {
|
} else {
|
||||||
nextItems = restoreLibraryItems(source, defaultStatus, {
|
nextItems = restoreLibraryItems(source, defaultStatus);
|
||||||
schemaMigrationRegistry: this.app.getSchemaMigrationRegistry(),
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
if (
|
if (
|
||||||
!prompt ||
|
!prompt ||
|
||||||
@@ -558,17 +549,12 @@ class AdapterTransaction {
|
|||||||
adapter: LibraryPersistenceAdapter,
|
adapter: LibraryPersistenceAdapter,
|
||||||
source: LibraryAdatapterSource,
|
source: LibraryAdatapterSource,
|
||||||
_queue = true,
|
_queue = true,
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry,
|
|
||||||
): Promise<LibraryItems> {
|
): Promise<LibraryItems> {
|
||||||
const task = () =>
|
const task = () =>
|
||||||
new Promise<LibraryItems>(async (resolve, reject) => {
|
new Promise<LibraryItems>(async (resolve, reject) => {
|
||||||
try {
|
try {
|
||||||
const data = await adapter.load({ source });
|
const data = await adapter.load({ source });
|
||||||
resolve(
|
resolve(restoreLibraryItems(data?.libraryItems || [], "published"));
|
||||||
restoreLibraryItems(data?.libraryItems || [], "published", {
|
|
||||||
schemaMigrationRegistry,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
reject(error);
|
reject(error);
|
||||||
}
|
}
|
||||||
@@ -583,36 +569,22 @@ class AdapterTransaction {
|
|||||||
|
|
||||||
static run = async <T>(
|
static run = async <T>(
|
||||||
adapter: LibraryPersistenceAdapter,
|
adapter: LibraryPersistenceAdapter,
|
||||||
schemaMigrationRegistry: SchemaMigrationRegistry | undefined,
|
|
||||||
fn: (transaction: AdapterTransaction) => Promise<T>,
|
fn: (transaction: AdapterTransaction) => Promise<T>,
|
||||||
) => {
|
) => {
|
||||||
const transaction = new AdapterTransaction(
|
const transaction = new AdapterTransaction(adapter);
|
||||||
adapter,
|
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
return AdapterTransaction.queue.push(() => fn(transaction));
|
return AdapterTransaction.queue.push(() => fn(transaction));
|
||||||
};
|
};
|
||||||
|
|
||||||
// ------------------
|
// ------------------
|
||||||
|
|
||||||
private adapter: LibraryPersistenceAdapter;
|
private adapter: LibraryPersistenceAdapter;
|
||||||
private schemaMigrationRegistry: SchemaMigrationRegistry | undefined;
|
|
||||||
|
|
||||||
constructor(
|
constructor(adapter: LibraryPersistenceAdapter) {
|
||||||
adapter: LibraryPersistenceAdapter,
|
|
||||||
schemaMigrationRegistry: SchemaMigrationRegistry | undefined,
|
|
||||||
) {
|
|
||||||
this.adapter = adapter;
|
this.adapter = adapter;
|
||||||
this.schemaMigrationRegistry = schemaMigrationRegistry;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
getLibraryItems(source: LibraryAdatapterSource) {
|
getLibraryItems(source: LibraryAdatapterSource) {
|
||||||
return AdapterTransaction.getLibraryItems(
|
return AdapterTransaction.getLibraryItems(this.adapter, source, false);
|
||||||
this.adapter,
|
|
||||||
source,
|
|
||||||
false,
|
|
||||||
this.schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -635,73 +607,68 @@ export const getLibraryItemsHash = (items: LibraryItems) => {
|
|||||||
const persistLibraryUpdate = async (
|
const persistLibraryUpdate = async (
|
||||||
adapter: LibraryPersistenceAdapter,
|
adapter: LibraryPersistenceAdapter,
|
||||||
update: LibraryUpdate,
|
update: LibraryUpdate,
|
||||||
schemaMigrationRegistry: SchemaMigrationRegistry | undefined,
|
|
||||||
): Promise<LibraryItems> => {
|
): Promise<LibraryItems> => {
|
||||||
try {
|
try {
|
||||||
librarySaveCounter++;
|
librarySaveCounter++;
|
||||||
|
|
||||||
return await AdapterTransaction.run(
|
return await AdapterTransaction.run(adapter, async (transaction) => {
|
||||||
adapter,
|
const nextLibraryItemsMap = arrayToMap(
|
||||||
schemaMigrationRegistry,
|
await transaction.getLibraryItems("save"),
|
||||||
async (transaction) => {
|
);
|
||||||
const nextLibraryItemsMap = arrayToMap(
|
|
||||||
await transaction.getLibraryItems("save"),
|
|
||||||
);
|
|
||||||
|
|
||||||
for (const [id] of update.deletedItems) {
|
for (const [id] of update.deletedItems) {
|
||||||
nextLibraryItemsMap.delete(id);
|
nextLibraryItemsMap.delete(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
const addedItems: LibraryItem[] = [];
|
||||||
|
|
||||||
|
// we want to merge current library items with the ones stored in the
|
||||||
|
// DB so that we don't lose any elements that for some reason aren't
|
||||||
|
// in the current editor library, which could happen when:
|
||||||
|
//
|
||||||
|
// 1. we haven't received an update deleting some elements
|
||||||
|
// (in which case it's still better to keep them in the DB lest
|
||||||
|
// it was due to a different reason)
|
||||||
|
// 2. we keep a single DB for all active editors, but the editors'
|
||||||
|
// libraries aren't synced or there's a race conditions during
|
||||||
|
// syncing
|
||||||
|
// 3. some other race condition, e.g. during init where emit updates
|
||||||
|
// for partial updates (e.g. you install a 3rd party library and
|
||||||
|
// init from DB only after — we emit events for both updates)
|
||||||
|
for (const [id, item] of update.addedItems) {
|
||||||
|
if (nextLibraryItemsMap.has(id)) {
|
||||||
|
// replace item with latest version
|
||||||
|
// TODO we could prefer the newer item instead
|
||||||
|
nextLibraryItemsMap.set(id, item);
|
||||||
|
} else {
|
||||||
|
// we want to prepend the new items with the ones that are already
|
||||||
|
// in DB to preserve the ordering we do in editor (newly added
|
||||||
|
// items are added to the beginning)
|
||||||
|
addedItems.push(item);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const addedItems: LibraryItem[] = [];
|
// replace existing items with their updated versions
|
||||||
|
if (update.updatedItems) {
|
||||||
// we want to merge current library items with the ones stored in the
|
for (const [id, item] of update.updatedItems) {
|
||||||
// DB so that we don't lose any elements that for some reason aren't
|
nextLibraryItemsMap.set(id, item);
|
||||||
// in the current editor library, which could happen when:
|
|
||||||
//
|
|
||||||
// 1. we haven't received an update deleting some elements
|
|
||||||
// (in which case it's still better to keep them in the DB lest
|
|
||||||
// it was due to a different reason)
|
|
||||||
// 2. we keep a single DB for all active editors, but the editors'
|
|
||||||
// libraries aren't synced or there's a race conditions during
|
|
||||||
// syncing
|
|
||||||
// 3. some other race condition, e.g. during init where emit updates
|
|
||||||
// for partial updates (e.g. you install a 3rd party library and
|
|
||||||
// init from DB only after — we emit events for both updates)
|
|
||||||
for (const [id, item] of update.addedItems) {
|
|
||||||
if (nextLibraryItemsMap.has(id)) {
|
|
||||||
// replace item with latest version
|
|
||||||
// TODO we could prefer the newer item instead
|
|
||||||
nextLibraryItemsMap.set(id, item);
|
|
||||||
} else {
|
|
||||||
// we want to prepend the new items with the ones that are already
|
|
||||||
// in DB to preserve the ordering we do in editor (newly added
|
|
||||||
// items are added to the beginning)
|
|
||||||
addedItems.push(item);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// replace existing items with their updated versions
|
const nextLibraryItems = addedItems.concat(
|
||||||
if (update.updatedItems) {
|
Array.from(nextLibraryItemsMap.values()),
|
||||||
for (const [id, item] of update.updatedItems) {
|
);
|
||||||
nextLibraryItemsMap.set(id, item);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const nextLibraryItems = addedItems.concat(
|
const version = getLibraryItemsHash(nextLibraryItems);
|
||||||
Array.from(nextLibraryItemsMap.values()),
|
|
||||||
);
|
|
||||||
|
|
||||||
const version = getLibraryItemsHash(nextLibraryItems);
|
if (version !== lastSavedLibraryItemsHash) {
|
||||||
|
await adapter.save({ libraryItems: nextLibraryItems });
|
||||||
|
}
|
||||||
|
|
||||||
if (version !== lastSavedLibraryItemsHash) {
|
lastSavedLibraryItemsHash = version;
|
||||||
await adapter.save({ libraryItems: nextLibraryItems });
|
|
||||||
}
|
|
||||||
|
|
||||||
lastSavedLibraryItemsHash = version;
|
return nextLibraryItems;
|
||||||
|
});
|
||||||
return nextLibraryItems;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
} finally {
|
} finally {
|
||||||
librarySaveCounter--;
|
librarySaveCounter--;
|
||||||
}
|
}
|
||||||
@@ -885,24 +852,16 @@ export const useHandleLibrary = (
|
|||||||
.then(async (libraryData) => {
|
.then(async (libraryData) => {
|
||||||
let restoredData: LibraryItems | null = null;
|
let restoredData: LibraryItems | null = null;
|
||||||
try {
|
try {
|
||||||
const schemaMigrationRegistry =
|
|
||||||
optsRef.current.excalidrawAPI?.getSchemaMigrationRegistry();
|
|
||||||
// if no library data to migrate, assume no migration needed
|
// if no library data to migrate, assume no migration needed
|
||||||
// and skip persisting to new data store, as well as well
|
// and skip persisting to new data store, as well as well
|
||||||
// clearing the old store via `migrationAdapter.clear()`
|
// clearing the old store via `migrationAdapter.clear()`
|
||||||
if (!libraryData) {
|
if (!libraryData) {
|
||||||
return AdapterTransaction.getLibraryItems(
|
return AdapterTransaction.getLibraryItems(adapter, "load");
|
||||||
adapter,
|
|
||||||
"load",
|
|
||||||
true,
|
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
restoredData = restoreLibraryItems(
|
restoredData = restoreLibraryItems(
|
||||||
libraryData.libraryItems || [],
|
libraryData.libraryItems || [],
|
||||||
"published",
|
"published",
|
||||||
{ schemaMigrationRegistry },
|
|
||||||
);
|
);
|
||||||
|
|
||||||
// we don't queue this operation because it's running inside
|
// we don't queue this operation because it's running inside
|
||||||
@@ -910,7 +869,6 @@ export const useHandleLibrary = (
|
|||||||
const nextItems = await persistLibraryUpdate(
|
const nextItems = await persistLibraryUpdate(
|
||||||
adapter,
|
adapter,
|
||||||
createLibraryUpdate([], restoredData),
|
createLibraryUpdate([], restoredData),
|
||||||
schemaMigrationRegistry,
|
|
||||||
);
|
);
|
||||||
try {
|
try {
|
||||||
await migrationAdapter.clear();
|
await migrationAdapter.clear();
|
||||||
@@ -933,23 +891,12 @@ export const useHandleLibrary = (
|
|||||||
.catch((error: any) => {
|
.catch((error: any) => {
|
||||||
console.error(`error during library migration: ${error.message}`);
|
console.error(`error during library migration: ${error.message}`);
|
||||||
// as a default, load latest library from current data source
|
// as a default, load latest library from current data source
|
||||||
return AdapterTransaction.getLibraryItems(
|
return AdapterTransaction.getLibraryItems(adapter, "load");
|
||||||
adapter,
|
|
||||||
"load",
|
|
||||||
true,
|
|
||||||
optsRef.current.excalidrawAPI?.getSchemaMigrationRegistry(),
|
|
||||||
);
|
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
initDataPromise.resolve(
|
initDataPromise.resolve(
|
||||||
promiseTry(
|
promiseTry(AdapterTransaction.getLibraryItems, adapter, "load"),
|
||||||
AdapterTransaction.getLibraryItems,
|
|
||||||
adapter,
|
|
||||||
"load",
|
|
||||||
true,
|
|
||||||
optsRef.current.excalidrawAPI?.getSchemaMigrationRegistry(),
|
|
||||||
),
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1011,11 +958,7 @@ export const useHandleLibrary = (
|
|||||||
lastSavedLibraryItemsHash !==
|
lastSavedLibraryItemsHash !==
|
||||||
getLibraryItemsHash(nextLibraryItems)
|
getLibraryItemsHash(nextLibraryItems)
|
||||||
) {
|
) {
|
||||||
await persistLibraryUpdate(
|
await persistLibraryUpdate(adapter, update);
|
||||||
adapter,
|
|
||||||
update,
|
|
||||||
optsRef.current.excalidrawAPI?.getSchemaMigrationRegistry(),
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
|
|||||||
@@ -1,26 +1,39 @@
|
|||||||
|
import type { MaybePromise } from "@excalidraw/common/utility-types";
|
||||||
|
|
||||||
import type { ExcalidrawElement } from "@excalidraw/element/types";
|
import type { ExcalidrawElement } from "@excalidraw/element/types";
|
||||||
|
|
||||||
import { getFileHandleType, isImageFileHandleType } from "./blob";
|
import { getFileHandleType, isImageFileHandleType } from "./blob";
|
||||||
|
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-restricted-imports
|
||||||
import { exportCanvas, prepareElementsForExport } from ".";
|
import { exportCanvas, prepareElementsForExport } from ".";
|
||||||
|
|
||||||
import type { AppState, BinaryFiles } from "../types";
|
import type { AppState, BinaryFiles } from "../types";
|
||||||
|
|
||||||
export const resaveAsImageWithScene = async (
|
export const resaveAsImageWithScene = async (
|
||||||
elements: readonly ExcalidrawElement[],
|
data: MaybePromise<{
|
||||||
appState: AppState,
|
elements: readonly ExcalidrawElement[];
|
||||||
files: BinaryFiles,
|
appState: AppState;
|
||||||
name: string,
|
files: BinaryFiles;
|
||||||
|
}>,
|
||||||
|
fileHandle: FileSystemFileHandle,
|
||||||
|
filename: string,
|
||||||
) => {
|
) => {
|
||||||
const { exportBackground, viewBackgroundColor, fileHandle } = appState;
|
|
||||||
|
|
||||||
const fileHandleType = getFileHandleType(fileHandle);
|
const fileHandleType = getFileHandleType(fileHandle);
|
||||||
|
|
||||||
if (!fileHandle || !isImageFileHandleType(fileHandleType)) {
|
if (Math.random() < 1) {
|
||||||
|
throw new Error("OLALALALA");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isImageFileHandleType(fileHandleType)) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
"fileHandle should exist and should be of type svg or png when resaving",
|
"fileHandle should exist and should be of type svg or png when resaving",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let { elements, appState, files } = await data;
|
||||||
|
|
||||||
|
const { exportBackground, viewBackgroundColor } = appState;
|
||||||
|
|
||||||
appState = {
|
appState = {
|
||||||
...appState,
|
...appState,
|
||||||
exportEmbedScene: true,
|
exportEmbedScene: true,
|
||||||
@@ -35,7 +48,7 @@ export const resaveAsImageWithScene = async (
|
|||||||
await exportCanvas(fileHandleType, exportedElements, appState, files, {
|
await exportCanvas(fileHandleType, exportedElements, appState, files, {
|
||||||
exportBackground,
|
exportBackground,
|
||||||
viewBackgroundColor,
|
viewBackgroundColor,
|
||||||
name,
|
name: filename,
|
||||||
fileHandle,
|
fileHandle,
|
||||||
exportingFrame,
|
exportingFrame,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -82,10 +82,6 @@ import {
|
|||||||
getNormalizedZoom,
|
getNormalizedZoom,
|
||||||
} from "../scene";
|
} from "../scene";
|
||||||
|
|
||||||
import { migrateElements } from "./schema";
|
|
||||||
|
|
||||||
import type { SchemaMigrationRegistry } from "./schema";
|
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
AppState,
|
AppState,
|
||||||
BinaryFiles,
|
BinaryFiles,
|
||||||
@@ -159,7 +155,7 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
| ExcalidrawElbowArrowElement["startBinding"]
|
| ExcalidrawElbowArrowElement["startBinding"]
|
||||||
| ExcalidrawElbowArrowElement["endBinding"] = {
|
| ExcalidrawElbowArrowElement["endBinding"] = {
|
||||||
...binding,
|
...binding,
|
||||||
fixedPoint: normalizeFixedPoint(binding.fixedPoint ?? [0, 0]),
|
fixedPoint: normalizeFixedPoint(binding.fixedPoint),
|
||||||
mode: binding.mode || "orbit",
|
mode: binding.mode || "orbit",
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -180,7 +176,7 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
return {
|
return {
|
||||||
elementId: binding.elementId,
|
elementId: binding.elementId,
|
||||||
mode: binding.mode,
|
mode: binding.mode,
|
||||||
fixedPoint: normalizeFixedPoint(binding.fixedPoint || [0.5, 0.5]),
|
fixedPoint: normalizeFixedPoint(binding.fixedPoint),
|
||||||
} as FixedPointBinding | null;
|
} as FixedPointBinding | null;
|
||||||
}
|
}
|
||||||
return null;
|
return null;
|
||||||
@@ -189,15 +185,14 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
// binding schema v1 (legacy) -> attempt to migrate to v2
|
// binding schema v1 (legacy) -> attempt to migrate to v2
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
const targetBoundElement =
|
const targetBoundElement = targetElementsMap.get(binding.elementId) as
|
||||||
(targetElementsMap.get(binding.elementId) as ExcalidrawBindableElement) ||
|
| ExcalidrawBindableElement
|
||||||
undefined;
|
| undefined;
|
||||||
const boundElement =
|
const boundElement =
|
||||||
targetBoundElement ||
|
targetBoundElement ||
|
||||||
(existingElementsMap?.get(
|
(existingElementsMap?.get(binding.elementId) as
|
||||||
binding.elementId,
|
| ExcalidrawBindableElement
|
||||||
) as ExcalidrawBindableElement) ||
|
| undefined);
|
||||||
undefined;
|
|
||||||
const elementsMap = targetBoundElement
|
const elementsMap = targetBoundElement
|
||||||
? targetElementsMap
|
? targetElementsMap
|
||||||
: existingElementsMap;
|
: existingElementsMap;
|
||||||
@@ -212,11 +207,28 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
const mode = isPointInElement(p, boundElement, elementsMap)
|
const mode = isPointInElement(p, boundElement, elementsMap)
|
||||||
? "inside"
|
? "inside"
|
||||||
: "orbit";
|
: "orbit";
|
||||||
|
const safeElement = {
|
||||||
|
...element,
|
||||||
|
startBinding: element.startBinding?.elementId
|
||||||
|
? {
|
||||||
|
...element.startBinding,
|
||||||
|
mode,
|
||||||
|
fixedPoint: normalizeFixedPoint(element.startBinding.fixedPoint),
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
endBinding: element.endBinding?.elementId
|
||||||
|
? {
|
||||||
|
...element.endBinding,
|
||||||
|
mode,
|
||||||
|
fixedPoint: normalizeFixedPoint(element.endBinding.fixedPoint),
|
||||||
|
}
|
||||||
|
: null,
|
||||||
|
};
|
||||||
const focusPoint =
|
const focusPoint =
|
||||||
mode === "inside"
|
mode === "inside"
|
||||||
? p
|
? p
|
||||||
: projectFixedPointOntoDiagonal(
|
: projectFixedPointOntoDiagonal(
|
||||||
element,
|
safeElement,
|
||||||
p,
|
p,
|
||||||
boundElement,
|
boundElement,
|
||||||
startOrEnd,
|
startOrEnd,
|
||||||
@@ -224,7 +236,7 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
{ value: 1 as NormalizedZoomValue },
|
{ value: 1 as NormalizedZoomValue },
|
||||||
) || p;
|
) || p;
|
||||||
const { fixedPoint } = calculateFixedPointForNonElbowArrowBinding(
|
const { fixedPoint } = calculateFixedPointForNonElbowArrowBinding(
|
||||||
element,
|
safeElement,
|
||||||
boundElement,
|
boundElement,
|
||||||
startOrEnd,
|
startOrEnd,
|
||||||
elementsMap,
|
elementsMap,
|
||||||
@@ -247,7 +259,7 @@ const repairBinding = <T extends ExcalidrawArrowElement>(
|
|||||||
};
|
};
|
||||||
|
|
||||||
const restoreElementWithProperties = <
|
const restoreElementWithProperties = <
|
||||||
T extends Omit<ExcalidrawElement, "customData"> & {
|
T extends Required<Omit<ExcalidrawElement, "customData">> & {
|
||||||
customData?: ExcalidrawElement["customData"];
|
customData?: ExcalidrawElement["customData"];
|
||||||
/** @deprecated */
|
/** @deprecated */
|
||||||
boundElementIds?: readonly ExcalidrawElement["id"][];
|
boundElementIds?: readonly ExcalidrawElement["id"][];
|
||||||
@@ -289,10 +301,6 @@ const restoreElementWithProperties = <
|
|||||||
width: element.width || 0,
|
width: element.width || 0,
|
||||||
height: element.height || 0,
|
height: element.height || 0,
|
||||||
seed: element.seed ?? 1,
|
seed: element.seed ?? 1,
|
||||||
schemaState:
|
|
||||||
element.schemaState && typeof element.schemaState === "object"
|
|
||||||
? element.schemaState
|
|
||||||
: { tracks: {} },
|
|
||||||
groupIds: element.groupIds ?? [],
|
groupIds: element.groupIds ?? [],
|
||||||
frameId: element.frameId ?? null,
|
frameId: element.frameId ?? null,
|
||||||
roundness: element.roundness
|
roundness: element.roundness
|
||||||
@@ -513,9 +521,6 @@ export const restoreElement = (
|
|||||||
case "embeddable":
|
case "embeddable":
|
||||||
return restoreElementWithProperties(element, {});
|
return restoreElementWithProperties(element, {});
|
||||||
case "magicframe":
|
case "magicframe":
|
||||||
return restoreElementWithProperties(element, {
|
|
||||||
name: element.name ?? null,
|
|
||||||
});
|
|
||||||
case "frame":
|
case "frame":
|
||||||
return restoreElementWithProperties(element, {
|
return restoreElementWithProperties(element, {
|
||||||
name: element.name ?? null,
|
name: element.name ?? null,
|
||||||
@@ -644,25 +649,17 @@ export const restoreElements = <T extends ExcalidrawElement>(
|
|||||||
refreshDimensions?: boolean;
|
refreshDimensions?: boolean;
|
||||||
repairBindings?: boolean;
|
repairBindings?: boolean;
|
||||||
deleteInvisibleElements?: boolean;
|
deleteInvisibleElements?: boolean;
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry;
|
|
||||||
}
|
}
|
||||||
| undefined,
|
| undefined,
|
||||||
): CombineBrandsIfNeeded<T, OrderedExcalidrawElement> => {
|
): CombineBrandsIfNeeded<T, OrderedExcalidrawElement> => {
|
||||||
const migratedTargetElements = migrateElements(
|
|
||||||
targetElements as readonly ExcalidrawElement[] | undefined | null,
|
|
||||||
{
|
|
||||||
schemaMigrationRegistry: opts?.schemaMigrationRegistry,
|
|
||||||
},
|
|
||||||
) as readonly T[] | undefined | null;
|
|
||||||
|
|
||||||
// used to detect duplicate top-level element ids
|
// used to detect duplicate top-level element ids
|
||||||
const existingIds = new Set<string>();
|
const existingIds = new Set<string>();
|
||||||
const targetElementsMap = arrayToMap(migratedTargetElements || []);
|
const targetElementsMap = arrayToMap(targetElements || []);
|
||||||
const existingElementsMap = existingElements
|
const existingElementsMap = existingElements
|
||||||
? arrayToMap(existingElements)
|
? arrayToMap(existingElements)
|
||||||
: null;
|
: null;
|
||||||
const restoredElements = syncInvalidIndices(
|
const restoredElements = syncInvalidIndices(
|
||||||
(migratedTargetElements || []).reduce((elements, element) => {
|
(targetElements || []).reduce((elements, element) => {
|
||||||
// filtering out selection, which is legacy, no longer kept in elements,
|
// filtering out selection, which is legacy, no longer kept in elements,
|
||||||
// and causing issues if retained
|
// and causing issues if retained
|
||||||
if (element.type === "selection") {
|
if (element.type === "selection") {
|
||||||
@@ -972,14 +969,10 @@ export const restoreAppState = (
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
const restoreLibraryItem = (
|
const restoreLibraryItem = (libraryItem: LibraryItem) => {
|
||||||
libraryItem: LibraryItem,
|
|
||||||
opts?: { schemaMigrationRegistry?: SchemaMigrationRegistry },
|
|
||||||
) => {
|
|
||||||
const elements = restoreElements(
|
const elements = restoreElements(
|
||||||
getNonDeletedElements(libraryItem.elements),
|
getNonDeletedElements(libraryItem.elements),
|
||||||
null,
|
null,
|
||||||
{ schemaMigrationRegistry: opts?.schemaMigrationRegistry },
|
|
||||||
);
|
);
|
||||||
return elements.length ? { ...libraryItem, elements } : null;
|
return elements.length ? { ...libraryItem, elements } : null;
|
||||||
};
|
};
|
||||||
@@ -987,21 +980,17 @@ const restoreLibraryItem = (
|
|||||||
export const restoreLibraryItems = (
|
export const restoreLibraryItems = (
|
||||||
libraryItems: ImportedDataState["libraryItems"] = [],
|
libraryItems: ImportedDataState["libraryItems"] = [],
|
||||||
defaultStatus: LibraryItem["status"],
|
defaultStatus: LibraryItem["status"],
|
||||||
opts?: { schemaMigrationRegistry?: SchemaMigrationRegistry },
|
|
||||||
) => {
|
) => {
|
||||||
const restoredItems: LibraryItem[] = [];
|
const restoredItems: LibraryItem[] = [];
|
||||||
for (const item of libraryItems) {
|
for (const item of libraryItems) {
|
||||||
// migrate older libraries
|
// migrate older libraries
|
||||||
if (Array.isArray(item)) {
|
if (Array.isArray(item)) {
|
||||||
const restoredItem = restoreLibraryItem(
|
const restoredItem = restoreLibraryItem({
|
||||||
{
|
status: defaultStatus,
|
||||||
status: defaultStatus,
|
elements: item,
|
||||||
elements: item,
|
id: randomId(),
|
||||||
id: randomId(),
|
created: Date.now(),
|
||||||
created: Date.now(),
|
});
|
||||||
},
|
|
||||||
opts,
|
|
||||||
);
|
|
||||||
if (restoredItem) {
|
if (restoredItem) {
|
||||||
restoredItems.push(restoredItem);
|
restoredItems.push(restoredItem);
|
||||||
}
|
}
|
||||||
@@ -1010,15 +999,12 @@ export const restoreLibraryItems = (
|
|||||||
LibraryItem,
|
LibraryItem,
|
||||||
"id" | "status" | "created"
|
"id" | "status" | "created"
|
||||||
>;
|
>;
|
||||||
const restoredItem = restoreLibraryItem(
|
const restoredItem = restoreLibraryItem({
|
||||||
{
|
..._item,
|
||||||
..._item,
|
id: _item.id || randomId(),
|
||||||
id: _item.id || randomId(),
|
status: _item.status || defaultStatus,
|
||||||
status: _item.status || defaultStatus,
|
created: _item.created || Date.now(),
|
||||||
created: _item.created || Date.now(),
|
});
|
||||||
},
|
|
||||||
opts,
|
|
||||||
);
|
|
||||||
if (restoredItem) {
|
if (restoredItem) {
|
||||||
restoredItems.push(restoredItem);
|
restoredItems.push(restoredItem);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,408 +0,0 @@
|
|||||||
import { DEFAULT_ELEMENT_PROPS } from "@excalidraw/common";
|
|
||||||
|
|
||||||
import { API } from "../tests/helpers/api";
|
|
||||||
|
|
||||||
import {
|
|
||||||
CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
createSchemaMigrationRegistry,
|
|
||||||
type SchemaPlugin,
|
|
||||||
type SchemaMigration,
|
|
||||||
CORE_SUPPORTED_TRACKS,
|
|
||||||
migrateElements,
|
|
||||||
resolveTrackVersion,
|
|
||||||
SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
SCHEMA_MIGRATIONS,
|
|
||||||
validateSchemaMigrations,
|
|
||||||
validateSchemaPlugins,
|
|
||||||
} from "./schema";
|
|
||||||
|
|
||||||
describe("schema migration", () => {
|
|
||||||
it("should migrate legacy frame backgrounds to transparent", () => {
|
|
||||||
const frame = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ffc9c9",
|
|
||||||
}),
|
|
||||||
schemaState: { tracks: {} },
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([frame])!;
|
|
||||||
|
|
||||||
expect(migrated[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
expect(migrated[0].schemaState.tracks[CORE_FRAME_SCHEMA_TRACK]).toBe(
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should handle elements without schemaState", () => {
|
|
||||||
const frameWithoutSchemaState = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ffc9c9",
|
|
||||||
}),
|
|
||||||
schemaState: undefined,
|
|
||||||
} as any;
|
|
||||||
|
|
||||||
const textWithoutSchemaState = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "text",
|
|
||||||
text: "",
|
|
||||||
}),
|
|
||||||
schemaState: undefined,
|
|
||||||
} as any;
|
|
||||||
|
|
||||||
const migrated = migrateElements([
|
|
||||||
frameWithoutSchemaState,
|
|
||||||
textWithoutSchemaState,
|
|
||||||
])!;
|
|
||||||
|
|
||||||
expect(migrated[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
expect(migrated[0].schemaState.tracks[CORE_FRAME_SCHEMA_TRACK]).toBe(
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
);
|
|
||||||
expect(migrated[1].schemaState).toEqual({ tracks: {} });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should keep latest-track frame backgrounds unchanged", () => {
|
|
||||||
const frame = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ffc9c9",
|
|
||||||
}),
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]:
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([frame])!;
|
|
||||||
|
|
||||||
expect(migrated[0].backgroundColor).toBe("#ffc9c9");
|
|
||||||
expect(migrated[0].schemaState.tracks[CORE_FRAME_SCHEMA_TRACK]).toBe(
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should normalize legacy frame backgrounds", () => {
|
|
||||||
const frame = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#a5d8ff",
|
|
||||||
}),
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]: SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([frame])!;
|
|
||||||
expect(migrated[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should resolve invalid track versions to initial", () => {
|
|
||||||
expect(resolveTrackVersion(undefined)).toBe(SCHEMA_INITIAL_TRACK_VERSION);
|
|
||||||
expect(resolveTrackVersion(0)).toBe(SCHEMA_INITIAL_TRACK_VERSION);
|
|
||||||
expect(resolveTrackVersion(2)).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should have a valid migration registry configuration", () => {
|
|
||||||
expect(validateSchemaMigrations(SCHEMA_MIGRATIONS)).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should reject invalid migration metadata", () => {
|
|
||||||
const invalidMigrations: SchemaMigration[] = [
|
|
||||||
{
|
|
||||||
id: "",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: 2.1,
|
|
||||||
title: "",
|
|
||||||
description: " ",
|
|
||||||
targetTypes: [],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "dup",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: 2.1,
|
|
||||||
title: "duplicate",
|
|
||||||
description: "duplicate version",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "dup",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: 3,
|
|
||||||
title: "duplicate id",
|
|
||||||
description: "duplicate id",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const errors = validateSchemaMigrations(invalidMigrations);
|
|
||||||
|
|
||||||
expect(errors.length).toBeGreaterThan(0);
|
|
||||||
expect(errors.join("\n")).toContain("integer version");
|
|
||||||
expect(errors.join("\n")).toContain("title must be non-empty");
|
|
||||||
expect(errors.join("\n")).toContain("non-empty description");
|
|
||||||
expect(errors.join("\n")).toContain("Duplicate schema migration id");
|
|
||||||
expect(errors.join("\n")).toContain("at least one target type");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should reject versions at or below initial", () => {
|
|
||||||
const errors = validateSchemaMigrations([
|
|
||||||
{
|
|
||||||
id: "invalid-start",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
title: "invalid start",
|
|
||||||
description: "bad version",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(errors.join("\n")).toContain("must be greater than 1");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should reject core track/version mismatch", () => {
|
|
||||||
const errors = validateSchemaMigrations([
|
|
||||||
{
|
|
||||||
id: "frame-v3",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK] + 1,
|
|
||||||
title: "future migration",
|
|
||||||
description: "future migration for test",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(errors.join("\n")).toContain(
|
|
||||||
`Core supported track "${CORE_FRAME_SCHEMA_TRACK}" (${CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK]}) must match last migration version`,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should reject undeclared core tracks", () => {
|
|
||||||
const errors = validateSchemaMigrations([
|
|
||||||
{
|
|
||||||
id: "unknown-core-track",
|
|
||||||
namespace: "core",
|
|
||||||
track: "excalidraw.shape.unknown",
|
|
||||||
toVersion: 2,
|
|
||||||
title: "unknown core track",
|
|
||||||
description: "should require supported-track declaration",
|
|
||||||
targetTypes: ["rectangle"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(errors.join("\n")).toContain(
|
|
||||||
"must be declared in CORE_SUPPORTED_TRACKS",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should reject invalid plugin metadata", () => {
|
|
||||||
const errors = validateSchemaPlugins([
|
|
||||||
{
|
|
||||||
id: "",
|
|
||||||
migrations: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "dup",
|
|
||||||
migrations: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "dup",
|
|
||||||
migrations: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: "core-overwrite",
|
|
||||||
migrations: [
|
|
||||||
{
|
|
||||||
id: "bad.core.migration",
|
|
||||||
namespace: "core",
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: 2,
|
|
||||||
title: "bad",
|
|
||||||
description: "bad",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => element,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
|
|
||||||
expect(errors.join("\n")).toContain("Schema plugin id must be non-empty");
|
|
||||||
expect(errors.join("\n")).toContain("Duplicate schema plugin id found");
|
|
||||||
expect(errors.join("\n")).toContain("cannot declare core migrations");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should not depend on temporary fields during migration", () => {
|
|
||||||
const frame = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#a5d8ff",
|
|
||||||
}),
|
|
||||||
schemaState: { tracks: {} },
|
|
||||||
};
|
|
||||||
const withTempField = {
|
|
||||||
...frame,
|
|
||||||
backgroundEnabled: false,
|
|
||||||
} as typeof frame & { backgroundEnabled: boolean };
|
|
||||||
|
|
||||||
const migratedBase = migrateElements([frame])!;
|
|
||||||
const migratedWithTempField = migrateElements([withTempField])!;
|
|
||||||
|
|
||||||
expect(migratedBase[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
expect(migratedWithTempField[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should use per-element track hints", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ff0000",
|
|
||||||
});
|
|
||||||
const frameFromModernSource = {
|
|
||||||
...frame,
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]:
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([frameFromModernSource])!;
|
|
||||||
|
|
||||||
expect(migrated[0].backgroundColor).toBe("#ff0000");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should migrate mixed-hint elements individually", () => {
|
|
||||||
const legacyFrame = {
|
|
||||||
...API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ff0000",
|
|
||||||
}),
|
|
||||||
schemaState: { tracks: {} },
|
|
||||||
};
|
|
||||||
const modernFrame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#00ff00",
|
|
||||||
});
|
|
||||||
const modernFrameWithTrack = {
|
|
||||||
...modernFrame,
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]:
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([legacyFrame, modernFrameWithTrack])!;
|
|
||||||
|
|
||||||
expect(migrated[0].backgroundColor).toBe(
|
|
||||||
DEFAULT_ELEMENT_PROPS.backgroundColor,
|
|
||||||
);
|
|
||||||
expect(migrated[1].backgroundColor).toBe("#00ff00");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should preserve higher-than-supported track versions", () => {
|
|
||||||
const frame = API.createElement({
|
|
||||||
type: "frame",
|
|
||||||
backgroundColor: "#ff0000",
|
|
||||||
});
|
|
||||||
const futureFrame = {
|
|
||||||
...frame,
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]:
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK] + 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([futureFrame])!;
|
|
||||||
expect(migrated[0].schemaState.tracks[CORE_FRAME_SCHEMA_TRACK]).toBe(
|
|
||||||
CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK] + 1,
|
|
||||||
);
|
|
||||||
expect(migrated[0].backgroundColor).toBe("#ff0000");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should normalize invalid schema state and preserve unknown tracks", () => {
|
|
||||||
const rect = {
|
|
||||||
...API.createElement({ type: "rectangle" }),
|
|
||||||
schemaState: {
|
|
||||||
tracks: {
|
|
||||||
"host.myapp.card": 4,
|
|
||||||
[CORE_FRAME_SCHEMA_TRACK]: 0,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrated = migrateElements([rect])!;
|
|
||||||
expect(migrated[0].schemaState.tracks[CORE_FRAME_SCHEMA_TRACK]).toBe(
|
|
||||||
SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
);
|
|
||||||
expect(migrated[0].schemaState.tracks["host.myapp.card"]).toBe(4);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should not run plugin migrations unless plugins are provided", () => {
|
|
||||||
const rect = API.createElement({
|
|
||||||
type: "rectangle",
|
|
||||||
backgroundColor: "#ffd8a8",
|
|
||||||
});
|
|
||||||
const plugin: SchemaPlugin = {
|
|
||||||
id: "myapp",
|
|
||||||
migrations: [
|
|
||||||
{
|
|
||||||
id: "host.myapp.rect.normalize.v2",
|
|
||||||
namespace: "host.myapp",
|
|
||||||
track: "host.myapp.rectangle",
|
|
||||||
toVersion: 2,
|
|
||||||
title: "normalize rect background",
|
|
||||||
description: "plugin migration for testing",
|
|
||||||
targetTypes: ["rectangle"],
|
|
||||||
apply: (element) =>
|
|
||||||
element.type === "rectangle"
|
|
||||||
? { ...element, backgroundColor: "#12b886" }
|
|
||||||
: element,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
|
|
||||||
const migratedWithoutPlugin = migrateElements([rect])!;
|
|
||||||
const migratedWithPlugin = migrateElements([rect], {
|
|
||||||
schemaMigrationRegistry: createSchemaMigrationRegistry([plugin]),
|
|
||||||
})!;
|
|
||||||
|
|
||||||
expect(migratedWithoutPlugin[0].backgroundColor).toBe("#ffd8a8");
|
|
||||||
expect(
|
|
||||||
migratedWithoutPlugin[0].schemaState.tracks["host.myapp.rectangle"],
|
|
||||||
).toBe(undefined);
|
|
||||||
expect(migratedWithPlugin[0].backgroundColor).toBe("#12b886");
|
|
||||||
expect(
|
|
||||||
migratedWithPlugin[0].schemaState.tracks["host.myapp.rectangle"],
|
|
||||||
).toBe(2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,443 +0,0 @@
|
|||||||
import {
|
|
||||||
CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
SCHEMA_CORE_NAMESPACE,
|
|
||||||
SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
CORE_SUPPORTED_TRACKS,
|
|
||||||
} from "@excalidraw/element/schema";
|
|
||||||
|
|
||||||
import type { SchemaNamespace, SchemaTrack } from "@excalidraw/element/schema";
|
|
||||||
import type { ExcalidrawElement } from "@excalidraw/element/types";
|
|
||||||
|
|
||||||
export {
|
|
||||||
CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
CORE_SUPPORTED_TRACKS,
|
|
||||||
SCHEMA_CORE_NAMESPACE,
|
|
||||||
SCHEMA_INITIAL_TRACK_VERSION,
|
|
||||||
};
|
|
||||||
export type { SchemaNamespace, SchemaTrack };
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Schema migration flow:
|
|
||||||
* 0) Compile schema config from core migrations + optional host plugins.
|
|
||||||
* - validate plugin metadata
|
|
||||||
* - validate migration ordering/metadata
|
|
||||||
* - derive per-track supported versions for this registry
|
|
||||||
* 1) Normalize element.schemaState.tracks (invalid/missing -> initial track version).
|
|
||||||
* 2) Iterate compiled migrations in declaration order.
|
|
||||||
* 3) For matching element types, apply only forward migrations that are
|
|
||||||
* supported by the current registry config (never re-run, never downgrade).
|
|
||||||
* 4) Stamp migrated track versions back onto each element.
|
|
||||||
*/
|
|
||||||
/** One migration step for a single track version bump. */
|
|
||||||
export type SchemaMigration = {
|
|
||||||
/** Stable unique id for validation and debugging. */
|
|
||||||
id: string;
|
|
||||||
/** Owner of the migration: core or a host namespace. */
|
|
||||||
namespace: SchemaNamespace;
|
|
||||||
/** Version line this migration belongs to. */
|
|
||||||
track: SchemaTrack;
|
|
||||||
/** Target version reached after applying this migration. */
|
|
||||||
toVersion: number;
|
|
||||||
/** Human-readable metadata for maintainers/reviewers. */
|
|
||||||
title: string;
|
|
||||||
description: string;
|
|
||||||
/** Which element types this migration may transform ("*" = all). */
|
|
||||||
targetTypes: readonly ExcalidrawElement["type"][] | "*";
|
|
||||||
/** Pure transform for a single element. */
|
|
||||||
apply: (element: ExcalidrawElement) => ExcalidrawElement;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Optional host-provided migration bundle.
|
|
||||||
* Plugins are additive and may only declare host namespace migrations.
|
|
||||||
*/
|
|
||||||
export type SchemaPlugin = {
|
|
||||||
/** Stable plugin id for diagnostics. */
|
|
||||||
id: string;
|
|
||||||
/** Host migration steps merged with core migrations into one registry. */
|
|
||||||
migrations: readonly SchemaMigration[];
|
|
||||||
};
|
|
||||||
|
|
||||||
/** Default plugin registry (intentionally empty in core). */
|
|
||||||
export const SCHEMA_PLUGINS: readonly SchemaPlugin[] = [];
|
|
||||||
|
|
||||||
export type SchemaMigrationRegistry = Readonly<{
|
|
||||||
/** Fully validated core + host migrations used for this run. */
|
|
||||||
migrations: readonly SchemaMigration[];
|
|
||||||
/** Latest supported version for each known track in this run. */
|
|
||||||
supportedTrackVersions: Readonly<Record<string, number>>;
|
|
||||||
}>;
|
|
||||||
|
|
||||||
export const SCHEMA_MIGRATIONS: readonly SchemaMigration[] = [
|
|
||||||
{
|
|
||||||
id: "core.frame.background.normalize.v2",
|
|
||||||
namespace: SCHEMA_CORE_NAMESPACE,
|
|
||||||
track: CORE_FRAME_SCHEMA_TRACK,
|
|
||||||
toVersion: CORE_SUPPORTED_TRACKS[CORE_FRAME_SCHEMA_TRACK],
|
|
||||||
title: "Normalize legacy frame backgrounds",
|
|
||||||
description:
|
|
||||||
"Frames saved before frame track v2 must render without visible fill, so normalize backgroundColor to transparent on restore.",
|
|
||||||
targetTypes: ["frame"],
|
|
||||||
apply: (element) => {
|
|
||||||
if (element.type !== "frame") {
|
|
||||||
return element;
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
...element,
|
|
||||||
backgroundColor: "transparent",
|
|
||||||
};
|
|
||||||
},
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
export const resolveTrackVersion = (trackVersion: unknown) => {
|
|
||||||
if (
|
|
||||||
Number.isInteger(trackVersion) &&
|
|
||||||
(trackVersion as number) >= SCHEMA_INITIAL_TRACK_VERSION
|
|
||||||
) {
|
|
||||||
return trackVersion as number;
|
|
||||||
}
|
|
||||||
return SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
};
|
|
||||||
|
|
||||||
const normalizeSchemaTracks = (tracks: unknown) => {
|
|
||||||
if (!tracks || typeof tracks !== "object") {
|
|
||||||
return {} as Record<string, number>;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Object.entries(tracks as Record<string, unknown>).reduce<
|
|
||||||
Record<string, number>
|
|
||||||
>((acc, [track, version]) => {
|
|
||||||
const normalizedVersion = resolveTrackVersion(version);
|
|
||||||
if (normalizedVersion >= SCHEMA_INITIAL_TRACK_VERSION) {
|
|
||||||
acc[track] = normalizedVersion;
|
|
||||||
}
|
|
||||||
return acc;
|
|
||||||
}, {});
|
|
||||||
};
|
|
||||||
|
|
||||||
const normalizeElementSchemaState = (
|
|
||||||
element: ExcalidrawElement,
|
|
||||||
): ExcalidrawElement["schemaState"] => {
|
|
||||||
const tracks = normalizeSchemaTracks(
|
|
||||||
(
|
|
||||||
element as ExcalidrawElement & {
|
|
||||||
schemaState?: ExcalidrawElement["schemaState"];
|
|
||||||
}
|
|
||||||
).schemaState?.tracks,
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
|
||||||
tracks,
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const ensureElementSchemaState = (element: ExcalidrawElement) => {
|
|
||||||
const normalizedSchemaState = normalizeElementSchemaState(element);
|
|
||||||
|
|
||||||
// Fast path: avoid reallocating when element already has normalized state.
|
|
||||||
if (element.schemaState === normalizedSchemaState) {
|
|
||||||
return element;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
element.schemaState &&
|
|
||||||
Object.keys(element.schemaState?.tracks || {}).length ===
|
|
||||||
Object.keys(normalizedSchemaState.tracks).length &&
|
|
||||||
Object.entries(normalizedSchemaState.tracks).every(
|
|
||||||
([track, version]) => element.schemaState?.tracks?.[track] === version,
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
return element;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
...element,
|
|
||||||
schemaState: normalizedSchemaState,
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const getTrackVersion = (element: ExcalidrawElement, track: SchemaTrack) => {
|
|
||||||
return resolveTrackVersion(element.schemaState.tracks[track]);
|
|
||||||
};
|
|
||||||
|
|
||||||
const withTrackVersion = (
|
|
||||||
element: ExcalidrawElement,
|
|
||||||
track: SchemaTrack,
|
|
||||||
version: number,
|
|
||||||
) => {
|
|
||||||
if (element.schemaState.tracks[track] === version) {
|
|
||||||
return element;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
...element,
|
|
||||||
schemaState: {
|
|
||||||
...element.schemaState,
|
|
||||||
tracks: {
|
|
||||||
...element.schemaState.tracks,
|
|
||||||
[track]: version,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const migrationMatchesElementType = (
|
|
||||||
migration: SchemaMigration,
|
|
||||||
element: ExcalidrawElement,
|
|
||||||
) => {
|
|
||||||
return (
|
|
||||||
migration.targetTypes === "*" ||
|
|
||||||
migration.targetTypes.includes(element.type)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const validateSchemaMigrations = (
|
|
||||||
migrations: readonly SchemaMigration[],
|
|
||||||
) => {
|
|
||||||
const errors: string[] = [];
|
|
||||||
const seenIds = new Set<string>();
|
|
||||||
const previousVersionByTrack = new Map<string, number>();
|
|
||||||
|
|
||||||
for (const migration of migrations) {
|
|
||||||
if (!migration.id.trim()) {
|
|
||||||
errors.push("Migration id must be non-empty.");
|
|
||||||
}
|
|
||||||
if (seenIds.has(migration.id)) {
|
|
||||||
errors.push(`Duplicate schema migration id found: ${migration.id}.`);
|
|
||||||
}
|
|
||||||
seenIds.add(migration.id);
|
|
||||||
|
|
||||||
if (!migration.title.trim()) {
|
|
||||||
errors.push(`Migration "${migration.id}" title must be non-empty.`);
|
|
||||||
}
|
|
||||||
if (!migration.description.trim()) {
|
|
||||||
errors.push(
|
|
||||||
`Migration "${migration.id}" must include a non-empty description.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Number.isInteger(migration.toVersion)) {
|
|
||||||
errors.push(`Migration "${migration.id}" must use an integer version.`);
|
|
||||||
}
|
|
||||||
if (migration.toVersion <= SCHEMA_INITIAL_TRACK_VERSION) {
|
|
||||||
errors.push(
|
|
||||||
`Migration "${migration.id}" version must be greater than ${SCHEMA_INITIAL_TRACK_VERSION}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
migration.targetTypes !== "*" &&
|
|
||||||
(!migration.targetTypes.length ||
|
|
||||||
migration.targetTypes.some((type) => !type))
|
|
||||||
) {
|
|
||||||
errors.push(
|
|
||||||
`Migration "${migration.id}" must declare at least one target type.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const trackKey = `${migration.namespace}|${migration.track}`;
|
|
||||||
const previousVersion =
|
|
||||||
previousVersionByTrack.get(trackKey) ?? SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
if (migration.toVersion <= previousVersion) {
|
|
||||||
errors.push(
|
|
||||||
`Migration "${migration.id}" must be ordered by increasing version within ${trackKey}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
previousVersionByTrack.set(trackKey, migration.toVersion);
|
|
||||||
|
|
||||||
if (
|
|
||||||
migration.namespace === SCHEMA_CORE_NAMESPACE &&
|
|
||||||
!migration.track.startsWith("excalidraw.")
|
|
||||||
) {
|
|
||||||
errors.push(
|
|
||||||
`Core migration "${migration.id}" must use an excalidraw.* track.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
migration.namespace === SCHEMA_CORE_NAMESPACE &&
|
|
||||||
!(migration.track in CORE_SUPPORTED_TRACKS)
|
|
||||||
) {
|
|
||||||
errors.push(
|
|
||||||
`Core migration "${migration.id}" track "${migration.track}" must be declared in CORE_SUPPORTED_TRACKS.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
migration.namespace !== SCHEMA_CORE_NAMESPACE &&
|
|
||||||
!migration.track.startsWith(`${migration.namespace}.`)
|
|
||||||
) {
|
|
||||||
errors.push(
|
|
||||||
`Host migration "${migration.id}" track must use namespace prefix ${migration.namespace}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const [track, supportedVersion] of Object.entries(
|
|
||||||
CORE_SUPPORTED_TRACKS,
|
|
||||||
)) {
|
|
||||||
const migrationTrackKey = `${SCHEMA_CORE_NAMESPACE}|${track}`;
|
|
||||||
const lastDeclaredVersion =
|
|
||||||
previousVersionByTrack.get(migrationTrackKey) ??
|
|
||||||
SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
|
|
||||||
if (lastDeclaredVersion !== supportedVersion) {
|
|
||||||
errors.push(
|
|
||||||
`Core supported track "${track}" (${supportedVersion}) must match last migration version (${lastDeclaredVersion}).`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return errors;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const validateSchemaPlugins = (plugins: readonly SchemaPlugin[]) => {
|
|
||||||
const errors: string[] = [];
|
|
||||||
const seenIds = new Set<string>();
|
|
||||||
|
|
||||||
for (const plugin of plugins) {
|
|
||||||
if (!plugin.id.trim()) {
|
|
||||||
errors.push("Schema plugin id must be non-empty.");
|
|
||||||
}
|
|
||||||
if (seenIds.has(plugin.id)) {
|
|
||||||
errors.push(`Duplicate schema plugin id found: ${plugin.id}.`);
|
|
||||||
}
|
|
||||||
seenIds.add(plugin.id);
|
|
||||||
|
|
||||||
for (const migration of plugin.migrations) {
|
|
||||||
if (migration.namespace === SCHEMA_CORE_NAMESPACE) {
|
|
||||||
errors.push(
|
|
||||||
`Schema plugin "${plugin.id}" cannot declare core migrations ("${migration.id}").`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return errors;
|
|
||||||
};
|
|
||||||
|
|
||||||
const collectPluginMigrations = (plugins: readonly SchemaPlugin[]) =>
|
|
||||||
plugins.flatMap((plugin) => plugin.migrations);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds the registry "latest version" map:
|
|
||||||
* - core tracks come from CORE_SUPPORTED_TRACKS
|
|
||||||
* - host tracks are inferred from provided plugin migrations
|
|
||||||
*/
|
|
||||||
const getSupportedTrackVersions = (
|
|
||||||
migrations: readonly SchemaMigration[],
|
|
||||||
): Readonly<Record<string, number>> => {
|
|
||||||
const supportedTrackVersions: Record<string, number> = {
|
|
||||||
...CORE_SUPPORTED_TRACKS,
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const migration of migrations) {
|
|
||||||
if (migration.namespace === SCHEMA_CORE_NAMESPACE) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const currentSupportedVersion =
|
|
||||||
supportedTrackVersions[migration.track] ?? SCHEMA_INITIAL_TRACK_VERSION;
|
|
||||||
if (migration.toVersion > currentSupportedVersion) {
|
|
||||||
supportedTrackVersions[migration.track] = migration.toVersion;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return supportedTrackVersions;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const createSchemaMigrationRegistry = (
|
|
||||||
plugins: readonly SchemaPlugin[] = SCHEMA_PLUGINS,
|
|
||||||
): SchemaMigrationRegistry => {
|
|
||||||
const pluginErrors = validateSchemaPlugins(plugins);
|
|
||||||
if (pluginErrors.length) {
|
|
||||||
throw new Error(
|
|
||||||
`Invalid schema plugin configuration:\n${pluginErrors.join("\n")}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const migrations = [
|
|
||||||
...SCHEMA_MIGRATIONS,
|
|
||||||
...collectPluginMigrations(plugins),
|
|
||||||
] as const;
|
|
||||||
|
|
||||||
const migrationErrors = validateSchemaMigrations(migrations);
|
|
||||||
if (migrationErrors.length) {
|
|
||||||
throw new Error(
|
|
||||||
`Invalid schema migration configuration:\n${migrationErrors.join("\n")}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
migrations,
|
|
||||||
supportedTrackVersions: getSupportedTrackVersions(migrations),
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const CORE_SCHEMA_MIGRATION_REGISTRY = createSchemaMigrationRegistry();
|
|
||||||
|
|
||||||
/** Uses cached core config by default, recompiles when plugins are provided. */
|
|
||||||
const resolveSchemaMigrationRegistry = (
|
|
||||||
schemaMigrationRegistry: SchemaMigrationRegistry | undefined,
|
|
||||||
) => schemaMigrationRegistry || CORE_SCHEMA_MIGRATION_REGISTRY;
|
|
||||||
|
|
||||||
const migrateElement = (
|
|
||||||
element: ExcalidrawElement,
|
|
||||||
schemaMigrationRegistry: SchemaMigrationRegistry,
|
|
||||||
) => {
|
|
||||||
// Always migrate from a normalized per-element schema state.
|
|
||||||
let migratedElement = ensureElementSchemaState(element);
|
|
||||||
|
|
||||||
for (const migration of schemaMigrationRegistry.migrations) {
|
|
||||||
if (!migrationMatchesElementType(migration, migratedElement)) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const currentTrackVersion = getTrackVersion(
|
|
||||||
migratedElement,
|
|
||||||
migration.track,
|
|
||||||
);
|
|
||||||
const supportedTrackVersion =
|
|
||||||
schemaMigrationRegistry.supportedTrackVersions[migration.track] ??
|
|
||||||
currentTrackVersion;
|
|
||||||
|
|
||||||
// Never re-run or downgrade.
|
|
||||||
if (currentTrackVersion >= migration.toVersion) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Preserve future data: ignore migrations newer than what this app supports.
|
|
||||||
if (migration.toVersion > supportedTrackVersion) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Apply transform, then stamp the element's track version.
|
|
||||||
migratedElement = withTrackVersion(
|
|
||||||
migration.apply(migratedElement),
|
|
||||||
migration.track,
|
|
||||||
migration.toVersion,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return migratedElement;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const migrateElements = (
|
|
||||||
elements: readonly ExcalidrawElement[] | null | undefined,
|
|
||||||
opts?: {
|
|
||||||
schemaMigrationRegistry?: SchemaMigrationRegistry;
|
|
||||||
},
|
|
||||||
) => {
|
|
||||||
if (!elements) {
|
|
||||||
return elements;
|
|
||||||
}
|
|
||||||
|
|
||||||
const schemaMigrationRegistry = resolveSchemaMigrationRegistry(
|
|
||||||
opts?.schemaMigrationRegistry,
|
|
||||||
);
|
|
||||||
|
|
||||||
return elements.map((element) =>
|
|
||||||
migrateElement(element, schemaMigrationRegistry),
|
|
||||||
);
|
|
||||||
};
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user