@excalidraw/common 0.18.0-0fc927cb4 → 0.18.0-1acf66e

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

@@ -0,0 +1,32 @@
+import { getFontString } from "@excalidraw/common";
+import type { ChartType } from "@excalidraw/element/types";
+import type { NonDeletedExcalidrawElement } from "@excalidraw/element/types";
+import { type CartesianChartLayout, type CartesianChartType } from "./charts.constants";
+import type { ChartElements, Spreadsheet, SpreadsheetSeries } from "./charts.types";
+export declare const isSpreadsheetValidForChartType: (spreadsheet: Spreadsheet | null, chartType: ChartType) => boolean;
+export declare const getCartesianChartLayout: (chartType: CartesianChartType, seriesCount: number) => CartesianChartLayout;
+export declare const getChartDimensions: (spreadsheet: Spreadsheet, layout: CartesianChartLayout) => {
+    chartWidth: number;
+    chartHeight: number;
+};
+export declare const getRadarDimensions: () => {
+    chartWidth: number;
+    chartHeight: number;
+};
+export declare const getSeriesColors: (seriesCount: number, colorOffset: number) => readonly string[];
+export declare const getColorOffset: (colorSeed?: number) => number;
+export declare const getBackgroundColor: (colorOffset: number) => "#fff5f5" | "#ffc9c9" | "#ff8787" | "#fa5252" | "#e03131" | "#fff0f6" | "#fcc2d7" | "#f783ac" | "#e64980" | "#c2255c" | "#f8f0fc" | "#eebefa" | "#da77f2" | "#be4bdb" | "#9c36b5" | "#f3f0ff" | "#d0bfff" | "#9775fa" | "#7950f2" | "#6741d9" | "#e7f5ff" | "#a5d8ff" | "#4dabf7" | "#228be6" | "#1971c2" | "#e3fafc" | "#99e9f2" | "#3bc9db" | "#15aabf" | "#0c8599" | "#e6fcf5" | "#96f2d7" | "#38d9a9" | "#12b886" | "#099268" | "#ebfbee" | "#b2f2bb" | "#69db7c" | "#40c057" | "#2f9e44" | "#fff9db" | "#ffec99" | "#ffd43b" | "#fab005" | "#f08c00" | "#fff4e6" | "#ffd8a8" | "#ffa94d" | "#fd7e14" | "#e8590c";
+export declare const getRadarValueScale: (series: SpreadsheetSeries[], _labelsLength: number) => {
+    renderSteps: boolean;
+    normalize: (value: number, _axisIndex: number) => number;
+};
+export declare const getRadarDisplayText: (text: string, fontString: ReturnType<typeof getFontString>, maxWidth: number) => string;
+export declare const createRadarAxisLabels: (labels: readonly string[], angles: readonly number[], centerX: number, centerY: number, radius: number, backgroundColor: string) => {
+    axisLabels: ChartElements;
+    axisLabelTopY: number;
+    axisLabelBottomY: number;
+};
+export declare const createSeriesLegend: (series: SpreadsheetSeries[], seriesColors: readonly string[], centerX: number, minLegendTopY: number, fallbackLegendY: number, backgroundColor: string) => ChartElements;
+export declare const getRotatedTextElementBottom: (element: NonDeletedExcalidrawElement) => number;
+export declare const chartXLabels: (spreadsheet: Spreadsheet, x: number, y: number, backgroundColor: string, layout: CartesianChartLayout) => ChartElements;
+export declare const chartBaseElements: (spreadsheet: Spreadsheet, x: number, y: number, backgroundColor: string, layout: CartesianChartLayout, maxValue?: number, debug?: boolean) => ChartElements;

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

@@ -0,0 +1,2 @@
+import type { ChartElements, Spreadsheet } from "./charts.types";
+export declare const renderLineChart: (spreadsheet: Spreadsheet, x: number, y: number, colorSeed?: number) => ChartElements;

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

@@ -0,0 +1,10 @@
+import { type ParseSpreadsheetResult } from "./charts.types";
+/**
+ * @private exported for testing
+ */
+export declare const tryParseNumber: (s: string) => number | null;
+/**
+ * @private exported for testing
+ */
+export declare const tryParseCells: (cells: string[][]) => ParseSpreadsheetResult;
+export declare const tryParseSpreadsheet: (text: string) => ParseSpreadsheetResult;

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

@@ -0,0 +1,2 @@
+import type { ChartElements, Spreadsheet } from "./charts.types";
+export declare const renderRadarChart: (spreadsheet: Spreadsheet, x: number, y: number, colorSeed?: number) => ChartElements | null;

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

@@ -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;
+};

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

@@ -0,0 +1,7 @@
+import type { ChartType } from "@excalidraw/element/types";
+import { tryParseCells, tryParseNumber, tryParseSpreadsheet } from "./charts.parse";
+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 declare const renderSpreadsheet: (chartType: ChartType, spreadsheet: Spreadsheet, x: number, y: number, colorSeed?: number) => ChartElements | null;

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

@@ -1,13 +1,13 @@
 import { ALLOWED_PASTE_MIME_TYPES } from "@excalidraw/common";
+import type { ValueOf } from "@excalidraw/common/utility-types";
+import type { IMAGE_MIME_TYPES, STRING_MIME_TYPES } from "@excalidraw/common";
 import type { ExcalidrawElement, NonDeletedExcalidrawElement } from "@excalidraw/element/types";
-import type { Spreadsheet } from "./charts";
 import type { BinaryFiles } from "./types";
 export type PastedMixedContent = {
     type: "text" | "imageUrl";
     value: string;
 }[];
 export interface ClipboardData {
-    spreadsheet?: Spreadsheet;
     elements?: readonly ExcalidrawElement[];
     files?: BinaryFiles;
     text?: string;
@@ -20,33 +20,21 @@ export declare const probablySupportsClipboardReadText: boolean;
 export declare const probablySupportsClipboardWriteText: boolean;
 export declare const probablySupportsClipboardBlob: boolean;
 export declare const createPasteEvent: ({ types, files, }: {
-    types?: {
-        "text/plain"?: string | File | undefined;
-        "text/html"?: string | File | undefined;
-        "image/svg+xml"?: string | File | undefined;
-        "image/png"?: string | File | undefined;
-        "image/jpeg"?: string | File | undefined;
-        "image/gif"?: string | File | undefined;
-        "image/webp"?: string | File | undefined;
-        "image/bmp"?: string | File | undefined;
-        "image/x-icon"?: string | File | undefined;
-        "image/avif"?: string | File | undefined;
-        "image/jfif"?: string | File | undefined;
-    } | undefined;
-    files?: File[] | undefined;
+    types?: { [key in AllowedPasteMimeTypes]?: string | File; };
+    files?: File[];
 }) => ClipboardEvent;
 export declare const serializeAsClipboardJSON: ({ elements, files, }: {
     elements: readonly NonDeletedExcalidrawElement[];
     files: BinaryFiles | null;
 }) => string;
-export declare const copyToClipboard: (elements: readonly NonDeletedExcalidrawElement[], files: BinaryFiles | null, clipboardEvent?: ClipboardEvent | null) => Promise<void>;
+export declare const copyToClipboard: (elements: readonly NonDeletedExcalidrawElement[], files: BinaryFiles | null, 
+/** supply if available to make the operation more certain to succeed */
+clipboardEvent?: ClipboardEvent | null) => Promise<void>;
 /**
  * Reads OS clipboard programmatically. May not work on all browsers.
  * Will prompt user for permission if not granted.
  */
 export declare const readSystemClipboard: () => Promise<{
-    "text/plain"?: string | File | undefined;
-    "text/html"?: string | File | undefined;
     "image/svg+xml"?: string | File | undefined;
     "image/png"?: string | File | undefined;
     "image/jpeg"?: string | File | undefined;
@@ -56,11 +44,61 @@ export declare const readSystemClipboard: () => Promise<{
     "image/x-icon"?: string | File | undefined;
     "image/avif"?: string | File | undefined;
     "image/jfif"?: string | File | undefined;
+    "text/plain"?: string | File | undefined;
+    "text/html"?: string | File | undefined;
+}>;
+type AllowedParsedDataTransferItem = {
+    type: ValueOf<typeof IMAGE_MIME_TYPES>;
+    kind: "file";
+    file: File;
+    fileHandle: FileSystemFileHandle | null;
+} | {
+    type: ValueOf<typeof STRING_MIME_TYPES>;
+    kind: "string";
+    value: string;
+};
+type ParsedDataTransferItem = {
+    type: string;
+    kind: "file";
+    file: File;
+    fileHandle: FileSystemFileHandle | null;
+} | {
+    type: string;
+    kind: "string";
+    value: string;
+};
+type ParsedDataTransferItemType<T extends AllowedParsedDataTransferItem["type"]> = AllowedParsedDataTransferItem & {
+    type: T;
+};
+export type ParsedDataTransferFile = Extract<AllowedParsedDataTransferItem, {
+    kind: "file";
 }>;
+export type ParsedDataTranferList = ParsedDataTransferItem[] & {
+    /**
+     * Only allows filtering by known `string` data types, since `file`
+     * types can have multiple items of the same type (e.g. multiple image files)
+     * unlike `string` data transfer items.
+     */
+    findByType: typeof findDataTransferItemType;
+    /**
+     * Only allows filtering by known `string` data types, since `file`
+     * types can have multiple items of the same type (e.g. multiple image files)
+     * unlike `string` data transfer items.
+     */
+    getData: typeof getDataTransferItemData;
+    getFiles: typeof getDataTransferFiles;
+};
+declare const findDataTransferItemType: <T extends ValueOf<typeof STRING_MIME_TYPES>>(this: ParsedDataTranferList, type: T) => ParsedDataTransferItemType<T> | null;
+declare const getDataTransferItemData: <T extends ValueOf<typeof STRING_MIME_TYPES>>(this: ParsedDataTranferList, type: T) => ParsedDataTransferItemType<ValueOf<typeof STRING_MIME_TYPES>>["value"] | null;
+declare const getDataTransferFiles: (this: ParsedDataTranferList) => ParsedDataTransferFile[];
+/** @returns list of MIME types, synchronously */
+export declare const parseDataTransferEventMimeTypes: (event: ClipboardEvent | DragEvent | React.DragEvent<HTMLDivElement>) => Set<string>;
+export declare const parseDataTransferEvent: (event: ClipboardEvent | DragEvent | React.DragEvent<HTMLDivElement>) => Promise<ParsedDataTranferList>;
 /**
  * Attempts to parse clipboard event.
  */
-export declare const parseClipboard: (event: ClipboardEvent, isPlainPaste?: boolean) => Promise<ClipboardData>;
+export declare const parseClipboard: (dataList: ParsedDataTranferList, isPlainPaste?: boolean) => Promise<ClipboardData>;
 export declare const copyBlobToClipboardAsPng: (blob: Blob | Promise<Blob>) => Promise<void>;
-export declare const copyTextToSystemClipboard: (text: string | null, clipboardEvent?: ClipboardEvent | null) => Promise<void>;
+export declare const copyTextToSystemClipboard: <MimeType extends ValueOf<typeof STRING_MIME_TYPES>>(text: string | { [K in MimeType]: string; } | null, clipboardEvent?: ClipboardEvent | null) => Promise<void>;
+export declare const isClipboardEvent: (event: React.SyntheticEvent | Event) => event is ClipboardEvent;
 export {};

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

@@ -1,30 +1,52 @@
-import type { ExcalidrawElement, NonDeletedElementsMap, NonDeletedSceneElementsMap } from "@excalidraw/element/types";
+import type { NonDeletedElementsMap, NonDeletedSceneElementsMap } from "@excalidraw/element/types";
 import "./Actions.scss";
-import type { AppClassProperties, AppProps, UIAppState, Zoom } from "../types";
+import type { AppClassProperties, UIAppState, AppState } from "../types";
 import type { ActionManager } from "../actions/manager";
-export declare const canChangeStrokeColor: (appState: UIAppState, targetElements: ExcalidrawElement[]) => boolean;
-export declare const canChangeBackgroundColor: (appState: UIAppState, targetElements: ExcalidrawElement[]) => boolean;
+export { canChangeStrokeColor, canChangeBackgroundColor, } from "./shapeActionPredicates";
+/**
+ * Full styles panel: the wide, always-expanded layout used on desktop when the
+ * UI is in "full" mode.
+ */
 export declare const SelectedShapeActions: ({ appState, elementsMap, renderAction, app, }: {
     appState: UIAppState;
     elementsMap: NonDeletedElementsMap | NonDeletedSceneElementsMap;
     renderAction: ActionManager["renderAction"];
     app: AppClassProperties;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const ShapesSwitcher: ({ activeTool, appState, app, UIOptions, }: {
-    activeTool: UIAppState["activeTool"];
+/**
+ * Compact styles panel — the collapsed, popover-driven layout used on tablets
+ * and on desktop when the UI is in "compact" mode.
+ */
+export declare const CompactShapeActions: ({ appState, elementsMap, renderAction, app, setAppState, }: {
     appState: UIAppState;
+    elementsMap: NonDeletedElementsMap | NonDeletedSceneElementsMap;
+    renderAction: ActionManager["renderAction"];
     app: AppClassProperties;
-    UIOptions: AppProps["UIOptions"];
+    setAppState: React.Component<any, AppState>["setState"];
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const ZoomActions: ({ renderAction, zoom, }: {
+/**
+ * Mobile styles panel — the horizontal action bar used on phones, with an
+ * overflow measurement that promotes duplicate/delete out of the popover when
+ * there is room.
+ */
+export declare const MobileShapeActions: ({ appState, elementsMap, renderAction, app, setAppState, }: {
+    appState: UIAppState;
+    elementsMap: NonDeletedElementsMap | NonDeletedSceneElementsMap;
+    renderAction: ActionManager["renderAction"];
+    app: AppClassProperties;
+    setAppState: React.Component<any, AppState>["setState"];
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const ZoomActions: ({ renderAction, }: {
     renderAction: ActionManager["renderAction"];
-    zoom: Zoom;
 }) => import("react/jsx-runtime").JSX.Element;
 export declare const UndoRedoActions: ({ renderAction, className, }: {
     renderAction: ActionManager["renderAction"];
-    className?: string | undefined;
+    className?: string;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const ExitZenModeAction: ({ actionManager, showExitZenModeBtn, }: {
+export declare const ExitZenModeButton: ({ actionManager, showExitZenModeBtn, }: {
     actionManager: ActionManager;
     showExitZenModeBtn: boolean;
 }) => import("react/jsx-runtime").JSX.Element;
+export declare const ExitViewModeButton: ({ actionManager, }: {
+    actionManager: ActionManager;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,4 @@
-export declare const activeConfirmDialogAtom: import("jotai/vanilla/atom").PrimitiveAtom<"clearCanvas" | null> & {
+export declare const activeConfirmDialogAtom: import("jotai").PrimitiveAtom<"clearCanvas" | null> & {
     init: "clearCanvas" | null;
 };
 export declare const ActiveConfirmDialog: () => import("react/jsx-runtime").JSX.Element | null;

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

@@ -0,0 +1,72 @@
+import type { ArrowEndpoint } from "@excalidraw/element";
+import type { ExcalidrawElement, ExcalidrawTextElement, FixedPoint, NonDeleted } from "@excalidraw/element/types";
+import type App from "./App";
+import type { AppState } from "../types";
+/**
+ * The text tool's interaction with arrows: the hover affordance showing where
+ * a click would attach text to an arrow — a free endpoint (binds the arrow to
+ * a new text element positioned against that endpoint) or the arrow's midpoint
+ * (adds a label bound to the arrow) — and the endpoint-bound flavor of
+ * drag-sizing a new text.
+ *
+ * The scene-level logic lives in `@excalidraw/element`'s `arrowEndpointText.ts`.
+ */
+export declare class AppArrowText {
+    private app;
+    constructor(app: App);
+    /**
+     * With the text tool active, an arrow under the cursor is a target for
+     * attaching text. Returns where the text would land (if anywhere), and keeps
+     * `appState.hoveredArrowTextAnchor` — which drives the highlight — in sync.
+     */
+    updateHoveredAnchor: (scenePointer: {
+        x: number;
+        y: number;
+    }) => AppState["hoveredArrowTextAnchor"];
+    /**
+     * Re-evaluates the hovered anchor at the last known pointer position — for
+     * events that change what a click would do without the pointer moving,
+     * i.e. the ctrl/cmd binding toggle. (Events that invalidate the anchor
+     * wholesale — tool switches, finalize, deselect — clear it directly
+     * instead.)
+     */
+    refresh: () => void;
+    /**
+     * A free arrow endpoint a new text could be bound to. Binding an endpoint is
+     * an arrow binding, so it follows the binding toggle (ctrl/cmd) like every
+     * other one — holding it makes the text tool drop plain text instead.
+     */
+    getBindableEndpointAtPosition(x: number, y: number): ArrowEndpoint | null;
+    /**
+     * Mirrors what `handleTextOnPointerDown` would do at this position, so the
+     * highlight can't promise something the click won't deliver.
+     */
+    private getAnchorAtPosition;
+    /**
+     * How a text should be created to read as a label for this endpoint — the
+     * side midpoint to bind, the alignment that pins it, and the scene position
+     * it must sit at. `targetStrokeWidth` is the caller's to provide so it can
+     * guarantee it matches the stroke width the text is then created with — the
+     * binding gap derives from it (see `getTextBindingForArrowEndpoint`).
+     */
+    getTextBinding({ arrow, startOrEnd }: ArrowEndpoint, targetStrokeWidth: number): {
+        fixedPoint: FixedPoint;
+        textAlign: import("@excalidraw/element/types").TextAlign;
+        verticalAlign: import("@excalidraw/element/types").VerticalAlign;
+        anchor: import("@excalidraw/math").GlobalPoint;
+    } | null;
+    /**
+     * Binds the arrow endpoint to the created text, at the side midpoint the
+     * placement resolved (`getTextBinding`'s `fixedPoint`).
+     */
+    bindText({ arrow, startOrEnd }: ArrowEndpoint, text: NonDeleted<ExcalidrawTextElement>, fixedPoint: FixedPoint): void;
+    /**
+     * A text bound to an arrow endpoint can't be positioned by the drag — the
+     * binding already placed it — so only its width is dragged out. Returns
+     * whether it owned the drag.
+     */
+    maybeDragNewText(newElement: ExcalidrawElement, pointerCoords: {
+        x: number;
+        y: number;
+    }): boolean;
+}

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

@@ -0,0 +1,31 @@
+import type App from "./App";
+import type { AppState } from "../types";
+/**
+ * Captures all cursor management for the interactive canvas.
+ *
+ * The canvas cursor is set exclusively imperatively, through this class —
+ * never via inline styles or React-rendered `style.cursor`, which React
+ * would rewrite on rerender whenever the computed value changes, clobbering
+ * cursors set here.
+ */
+export declare class AppCursor {
+    private app;
+    private eraserCanvasCache;
+    private eraserPreviewDataURL;
+    private drawShapeCanvasCache;
+    private drawShapePreviewDataURL;
+    constructor(app: App);
+    private get canvas();
+    set: (cursor: string) => void;
+    /**
+     * Resets to the resting cursor — the cursor shown when no interaction or
+     * hover affordance overrides it: the view-mode grab cursor when
+     * drag-to-pan applies, the active tool's cursor otherwise.
+     */
+    reset: () => void;
+    /** applies the given tool's cursor (defaults to the active tool) */
+    applyForTool: (activeTool?: AppState["activeTool"]) => void;
+    /** clears the inline cursor so the environment default (CSS) applies */
+    private clear;
+    private applyEraser;
+}