@misenkashari/excalidraw-common 1.0.0 → 1.0.3

package/dist/types/common/src/font-metadata.d.ts

@@ -0,0 +1,46 @@
+import type { ExcalidrawTextElement, FontFamilyValues } from "@excalidraw/element/types";
+/**
+ * Encapsulates font metrics with additional font metadata.
+ * */
+export interface FontMetadata {
+    /** for head & hhea metrics read the woff2 with https://fontdrop.info/ */
+    metrics: {
+        /** head.unitsPerEm metric */
+        unitsPerEm: 1000 | 1024 | 2048;
+        /** hhea.ascender metric */
+        ascender: number;
+        /** hhea.descender metric */
+        descender: number;
+        /** harcoded unitless line-height, https://github.com/excalidraw/excalidraw/pull/6360#issuecomment-1477635971 */
+        lineHeight: number;
+    };
+    /** flag to indicate a deprecated font */
+    deprecated?: true;
+    /**
+     * whether this is a font that users can use (= shown in font picker)
+     */
+    private?: true;
+    /** flag to indiccate a local-only font */
+    local?: true;
+    /** flag to indicate a fallback font */
+    fallback?: true;
+}
+export declare const FONT_METADATA: Record<number, FontMetadata>;
+/** Unicode ranges defined by google fonts */
+export declare const GOOGLE_FONTS_RANGES: {
+    LATIN: string;
+    LATIN_EXT: string;
+    CYRILIC_EXT: string;
+    CYRILIC: string;
+    VIETNAMESE: string;
+};
+/** local protocol to skip the local font from registering or inlining */
+export declare const LOCAL_FONT_PROTOCOL = "local:";
+/**
+ * Calculates vertical offset for a text with alphabetic baseline.
+ */
+export declare const getVerticalOffset: (fontFamily: ExcalidrawTextElement["fontFamily"], fontSize: ExcalidrawTextElement["fontSize"], lineHeightPx: number) => number;
+/**
+ * Gets line height for a selected family.
+ */
+export declare const getLineHeight: (fontFamily: FontFamilyValues) => ExcalidrawTextElement["lineHeight"];

package/dist/types/common/src/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./binary-heap";
+export * from "./bounds";
+export * from "./colors";
+export * from "./constants";
+export * from "./font-metadata";
+export * from "./queue";
+export * from "./keys";
+export * from "./points";
+export * from "./promise-pool";
+export * from "./random";
+export * from "./url";
+export * from "./utils";
+export * from "./emitter";
+export * from "./visualdebug";
+export * from "./editorInterface";

package/dist/types/common/src/keys.d.ts

@@ -0,0 +1,191 @@
+import type { ValueOf } from "./utility-types";
+export declare const CODES: {
+    readonly EQUAL: "Equal";
+    readonly MINUS: "Minus";
+    readonly NUM_ADD: "NumpadAdd";
+    readonly NUM_SUBTRACT: "NumpadSubtract";
+    readonly NUM_ZERO: "Numpad0";
+    readonly BRACKET_RIGHT: "BracketRight";
+    readonly BRACKET_LEFT: "BracketLeft";
+    readonly ONE: "Digit1";
+    readonly TWO: "Digit2";
+    readonly THREE: "Digit3";
+    readonly NINE: "Digit9";
+    readonly QUOTE: "Quote";
+    readonly ZERO: "Digit0";
+    readonly SLASH: "Slash";
+    readonly C: "KeyC";
+    readonly D: "KeyD";
+    readonly H: "KeyH";
+    readonly V: "KeyV";
+    readonly Z: "KeyZ";
+    readonly Y: "KeyY";
+    readonly R: "KeyR";
+    readonly S: "KeyS";
+};
+export declare const KEYS: {
+    readonly ARROW_DOWN: "ArrowDown";
+    readonly ARROW_LEFT: "ArrowLeft";
+    readonly ARROW_RIGHT: "ArrowRight";
+    readonly ARROW_UP: "ArrowUp";
+    readonly PAGE_UP: "PageUp";
+    readonly PAGE_DOWN: "PageDown";
+    readonly BACKSPACE: "Backspace";
+    readonly ALT: "Alt";
+    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
+    readonly DELETE: "Delete";
+    readonly ENTER: "Enter";
+    readonly ESCAPE: "Escape";
+    readonly QUESTION_MARK: "?";
+    readonly SPACE: " ";
+    readonly TAB: "Tab";
+    readonly CHEVRON_LEFT: "<";
+    readonly CHEVRON_RIGHT: ">";
+    readonly PERIOD: ".";
+    readonly COMMA: ",";
+    readonly SUBTRACT: "-";
+    readonly SLASH: "/";
+    readonly A: "a";
+    readonly C: "c";
+    readonly D: "d";
+    readonly E: "e";
+    readonly F: "f";
+    readonly G: "g";
+    readonly H: "h";
+    readonly I: "i";
+    readonly J: "j";
+    readonly L: "l";
+    readonly O: "o";
+    readonly P: "p";
+    readonly Q: "q";
+    readonly R: "r";
+    readonly S: "s";
+    readonly T: "t";
+    readonly V: "v";
+    readonly X: "x";
+    readonly Y: "y";
+    readonly Z: "z";
+    readonly K: "k";
+    readonly W: "w";
+    readonly 0: "0";
+    readonly 1: "1";
+    readonly 2: "2";
+    readonly 3: "3";
+    readonly 4: "4";
+    readonly 5: "5";
+    readonly 6: "6";
+    readonly 7: "7";
+    readonly 8: "8";
+    readonly 9: "9";
+};
+export type Key = keyof typeof KEYS;
+export declare const KeyCodeMap: Map<ValueOf<{
+    readonly ARROW_DOWN: "ArrowDown";
+    readonly ARROW_LEFT: "ArrowLeft";
+    readonly ARROW_RIGHT: "ArrowRight";
+    readonly ARROW_UP: "ArrowUp";
+    readonly PAGE_UP: "PageUp";
+    readonly PAGE_DOWN: "PageDown";
+    readonly BACKSPACE: "Backspace";
+    readonly ALT: "Alt";
+    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
+    readonly DELETE: "Delete";
+    readonly ENTER: "Enter";
+    readonly ESCAPE: "Escape";
+    readonly QUESTION_MARK: "?";
+    readonly SPACE: " ";
+    readonly TAB: "Tab";
+    readonly CHEVRON_LEFT: "<";
+    readonly CHEVRON_RIGHT: ">";
+    readonly PERIOD: ".";
+    readonly COMMA: ",";
+    readonly SUBTRACT: "-";
+    readonly SLASH: "/";
+    readonly A: "a";
+    readonly C: "c";
+    readonly D: "d";
+    readonly E: "e";
+    readonly F: "f";
+    readonly G: "g";
+    readonly H: "h";
+    readonly I: "i";
+    readonly J: "j";
+    readonly L: "l";
+    readonly O: "o";
+    readonly P: "p";
+    readonly Q: "q";
+    readonly R: "r";
+    readonly S: "s";
+    readonly T: "t";
+    readonly V: "v";
+    readonly X: "x";
+    readonly Y: "y";
+    readonly Z: "z";
+    readonly K: "k";
+    readonly W: "w";
+    readonly 0: "0";
+    readonly 1: "1";
+    readonly 2: "2";
+    readonly 3: "3";
+    readonly 4: "4";
+    readonly 5: "5";
+    readonly 6: "6";
+    readonly 7: "7";
+    readonly 8: "8";
+    readonly 9: "9";
+}>, ValueOf<{
+    readonly EQUAL: "Equal";
+    readonly MINUS: "Minus";
+    readonly NUM_ADD: "NumpadAdd";
+    readonly NUM_SUBTRACT: "NumpadSubtract";
+    readonly NUM_ZERO: "Numpad0";
+    readonly BRACKET_RIGHT: "BracketRight";
+    readonly BRACKET_LEFT: "BracketLeft";
+    readonly ONE: "Digit1";
+    readonly TWO: "Digit2";
+    readonly THREE: "Digit3";
+    readonly NINE: "Digit9";
+    readonly QUOTE: "Quote";
+    readonly ZERO: "Digit0";
+    readonly SLASH: "Slash";
+    readonly C: "KeyC";
+    readonly D: "KeyD";
+    readonly H: "KeyH";
+    readonly V: "KeyV";
+    readonly Z: "KeyZ";
+    readonly Y: "KeyY";
+    readonly R: "KeyR";
+    readonly S: "KeyS";
+}>>;
+export declare const isLatinChar: (key: string) => boolean;
+/**
+ * Used to match key events for any keyboard layout, especially on Windows and Linux,
+ * where non-latin character with modified (CMD) is not substituted with latin-based alternative.
+ *
+ * Uses `event.key` when it's latin, otherwise fallbacks to `event.code` (if mapping exists).
+ *
+ * Example of pressing "z" on different layouts, with the chosen key or code highlighted in []:
+ *
+ * Layout                | Code  | Key | Comment
+ * --------------------- | ----- | --- | -------
+ * U.S.                  |  KeyZ  | [z] |
+ * Czech                 |  KeyY  | [z] |
+ * Turkish               |  KeyN  | [z] |
+ * French                |  KeyW  | [z] |
+ * Macedonian            | [KeyZ] |  з  | z with cmd; з is Cyrillic equivalent of z
+ * Russian               | [KeyZ] |  я  | z with cmd
+ * Serbian               | [KeyZ] |  ѕ  | z with cmd
+ * Greek                 | [KeyZ] |  ζ  | z with cmd; also ζ is Greek equivalent of z
+ * Hebrew                | [KeyZ] |  ז  | z with cmd; also ז is Hebrew equivalent of z
+ * Pinyin - Simplified   |  KeyZ  | [z] | due to IME
+ * Cangije - Traditional | [KeyZ] |  重 | z with cmd
+ * Japanese              | [KeyZ] |  つ | z with cmd
+ * 2-Set Korean          | [KeyZ] |  ㅋ | z with cmd
+ *
+ * More details in https://github.com/excalidraw/excalidraw/pull/5944
+ */
+export declare const matchKey: (event: KeyboardEvent | React.KeyboardEvent<Element>, key: ValueOf<typeof KEYS>) => boolean;
+export declare const isArrowKey: (key: string) => key is "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp";
+export declare const shouldResizeFromCenter: (event: MouseEvent | KeyboardEvent) => boolean;
+export declare const shouldMaintainAspectRatio: (event: MouseEvent | KeyboardEvent) => boolean;
+export declare const shouldRotateWithDiscreteAngle: (event: MouseEvent | KeyboardEvent | React.PointerEvent<HTMLCanvasElement>) => boolean;

package/dist/types/common/src/points.d.ts

@@ -0,0 +1,9 @@
+import { type GlobalPoint, type LocalPoint } from "@excalidraw/math";
+import type { NullableGridSize } from "@excalidraw/excalidraw/types";
+export declare const getSizeFromPoints: (points: readonly (GlobalPoint | LocalPoint)[]) => {
+    width: number;
+    height: number;
+};
+/** @arg dimension, 0 for rescaling only x, 1 for y */
+export declare const rescalePoints: <Point extends GlobalPoint | LocalPoint>(dimension: 0 | 1, newSize: number, points: readonly Point[], normalize: boolean) => Point[];
+export declare const getGridPoint: (x: number, y: number, gridSize: NullableGridSize) => [number, number];

package/dist/types/common/src/promise-pool.d.ts

@@ -0,0 +1,6 @@
+export declare class PromisePool<T> {
+    private readonly pool;
+    private readonly entries;
+    constructor(source: IterableIterator<Promise<void | readonly [number, T]>>, concurrency: number);
+    all(): PromiseLike<T[]>;
+}

package/dist/types/common/src/queue.d.ts

@@ -0,0 +1,9 @@
+import type { MaybePromise } from "./utility-types";
+type Job<T, TArgs extends unknown[]> = (...args: TArgs) => MaybePromise<T>;
+export declare class Queue {
+    private jobs;
+    private running;
+    private tick;
+    push<TValue, TArgs extends unknown[]>(jobFactory: Job<TValue, TArgs>, ...args: TArgs): Promise<TValue>;
+}
+export {};

package/dist/types/common/src/random.d.ts

@@ -0,0 +1,3 @@
+export declare const randomInteger: () => number;
+export declare const reseed: (seed: number) => void;
+export declare const randomId: () => string;

package/dist/types/common/src/url.d.ts

@@ -0,0 +1,7 @@
+export declare const normalizeLink: (link: string) => string;
+export declare const isLocalLink: (link: string | null) => boolean;
+/**
+ * Returns URL sanitized and safe for usage in places such as
+ * iframe's src attribute or <a> href attributes.
+ */
+export declare const toValidURL: (link: string) => string;

package/dist/types/common/src/utility-types.d.ts

@@ -0,0 +1,37 @@
+export type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export type ValueOf<T> = T[keyof T];
+export type Merge<M, N> = Omit<M, keyof N> & N;
+/** utility type to assert that the second type is a subtype of the first type.
+ * Returns the subtype. */
+export type SubtypeOf<Supertype, Subtype extends Supertype> = Subtype;
+export type ResolutionType<T extends (...args: any) => any> = T extends (...args: any) => Promise<infer R> ? R : any;
+export type MarkOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type MarkRequired<T, RK extends keyof T> = Exclude<T, RK> & Required<Pick<T, RK>>;
+export type MarkNonNullable<T, K extends keyof T> = {
+    [P in K]-?: P extends K ? NonNullable<T[P]> : T[P];
+} & {
+    [P in keyof T]: T[P];
+};
+export type NonOptional<T> = Exclude<T, undefined>;
+export type SignatureType<T> = T extends (...args: infer R) => any ? R : never;
+export type CallableType<T extends (...args: any[]) => any> = (...args: SignatureType<T>) => ReturnType<T>;
+export type ForwardRef<T, P = any> = Parameters<CallableType<React.ForwardRefRenderFunction<T, P>>>[1];
+export type ExtractSetType<T extends Set<any>> = T extends Set<infer U> ? U : never;
+export type SameType<T, U> = T extends U ? (U extends T ? true : false) : false;
+export type Assert<T extends true> = T;
+export type NestedKeyOf<T, K = keyof T> = K extends keyof T & (string | number) ? `${K}` | (T[K] extends object ? `${K}.${NestedKeyOf<T[K]>}` : never) : never;
+export type SetLike<T> = Set<T> | T[];
+export type ReadonlySetLike<T> = ReadonlySet<T> | readonly T[];
+export type MakeBrand<T extends string> = {
+    [K in `~brand~${T}`]: T;
+};
+/** Maybe just promise or already fulfilled one! */
+export type MaybePromise<T> = T | Promise<T>;
+export type AllPossibleKeys<T> = T extends any ? keyof T : never;
+/** Strip all the methods or functions from a type */
+export type DTO<T> = {
+    [K in keyof T as T[K] extends Function ? never : K]: T[K];
+};
+export type MapEntry<M extends Map<any, any>> = M extends Map<infer K, infer V> ? [K, V] : never;

package/dist/types/common/src/utils.d.ts

@@ -0,0 +1,283 @@
+import type { FontFamilyValues, FontString } from "@excalidraw/element/types";
+import type { ActiveTool, AppState, ToolType, UnsubscribeCallback, Zoom } from "@excalidraw/excalidraw/types";
+import type { MaybePromise, ResolutionType } from "./utility-types";
+import type { EVENT } from "./constants";
+export declare const setDateTimeForTests: (dateTime: string) => void;
+export declare const getDateTime: () => string;
+export declare const capitalizeString: (str: string) => string;
+export declare const isToolIcon: (target: Element | EventTarget | null) => target is HTMLElement;
+export declare const isInputLike: (target: Element | EventTarget | null) => target is HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLBRElement | HTMLDivElement;
+export declare const isInteractive: (target: Element | EventTarget | null) => boolean;
+export declare const isWritableElement: (target: Element | EventTarget | null) => target is HTMLInputElement | HTMLTextAreaElement | HTMLBRElement | HTMLDivElement;
+export declare const getFontFamilyString: ({ fontFamily, }: {
+    fontFamily: FontFamilyValues;
+}) => string;
+/** returns fontSize+fontFamily string for assignment to DOM elements */
+export declare const getFontString: ({ fontSize, fontFamily, }: {
+    fontSize: number;
+    fontFamily: FontFamilyValues;
+}) => FontString;
+/** executes callback in the frame that's after the current one */
+export declare const nextAnimationFrame: (cb: () => any) => Promise<void>;
+export declare const debounce: <T extends any[]>(fn: (...args: T) => void, timeout: number) => {
+    (...args: T): void;
+    flush(): void;
+    cancel(): void;
+};
+export declare const throttleRAF: <T extends any[]>(fn: (...args: T) => void, opts?: {
+    trailing?: boolean;
+}) => {
+    (...args: T): void;
+    flush(): void;
+    cancel(): void;
+};
+/**
+ * Exponential ease-out method
+ *
+ * @param {number} k - The value to be tweened.
+ * @returns {number} The tweened value.
+ */
+export declare const easeOut: (k: number) => number;
+/**
+ * Animates values from `fromValues` to `toValues` using the requestAnimationFrame API.
+ * Executes the `onStep` callback on each step with the interpolated values.
+ * Returns a function that can be called to cancel the animation.
+ *
+ * @example
+ * // Example usage:
+ * const fromValues = { x: 0, y: 0 };
+ * const toValues = { x: 100, y: 200 };
+ * const onStep = ({x, y}) => {
+ *   setState(x, y)
+ * };
+ * const onCancel = () => {
+ *   console.log("Animation canceled");
+ * };
+ *
+ * const cancelAnimation = easeToValuesRAF({
+ *   fromValues,
+ *   toValues,
+ *   onStep,
+ *   onCancel,
+ * });
+ *
+ * // To cancel the animation:
+ * cancelAnimation();
+ */
+export declare const easeToValuesRAF: <T extends Record<keyof T, number>, K extends keyof T>({ fromValues, toValues, onStep, duration, interpolateValue, onStart, onEnd, onCancel, }: {
+    fromValues: T;
+    toValues: T;
+    /**
+     * Interpolate a single value.
+     * Return undefined to be handled by the default interpolator.
+     */
+    interpolateValue?: (fromValue: number, toValue: number, 
+    /** no easing applied  */
+    progress: number, key: K) => number | undefined;
+    onStep: (values: T) => void;
+    duration?: number;
+    onStart?: () => void;
+    onEnd?: () => void;
+    onCancel?: () => void;
+}) => () => void;
+export declare const chunk: <T extends any>(array: readonly T[], size: number) => T[][];
+export declare const selectNode: (node: Element) => void;
+export declare const removeSelection: () => void;
+export declare const distance: (x: number, y: number) => number;
+export declare const isSelectionLikeTool: (type: ToolType | "custom") => type is "selection" | "lasso";
+export declare const updateActiveTool: (appState: Pick<AppState, "activeTool">, data: (({
+    type: ToolType;
+} | {
+    type: "custom";
+    customType: string;
+}) & {
+    locked?: boolean;
+    fromSelection?: boolean;
+}) & {
+    lastActiveToolBeforeEraser?: ActiveTool | null;
+}) => AppState["activeTool"];
+export declare const isFullScreen: () => boolean;
+export declare const allowFullScreen: () => Promise<void>;
+export declare const exitFullScreen: () => Promise<void>;
+export declare const viewportCoordsToSceneCoords: ({ clientX, clientY }: {
+    clientX: number;
+    clientY: number;
+}, { zoom, offsetLeft, offsetTop, scrollX, scrollY, }: {
+    zoom: Zoom;
+    offsetLeft: number;
+    offsetTop: number;
+    scrollX: number;
+    scrollY: number;
+}) => {
+    x: number;
+    y: number;
+};
+export declare const sceneCoordsToViewportCoords: ({ sceneX, sceneY }: {
+    sceneX: number;
+    sceneY: number;
+}, { zoom, offsetLeft, offsetTop, scrollX, scrollY, }: {
+    zoom: Zoom;
+    offsetLeft: number;
+    offsetTop: number;
+    scrollX: number;
+    scrollY: number;
+}) => {
+    x: number;
+    y: number;
+};
+export declare const getGlobalCSSVariable: (name: string) => string;
+/**
+ * Checks whether first directional character is RTL. Meaning whether it starts
+ *  with RTL characters, or indeterminate (numbers etc.) characters followed by
+ *  RTL.
+ * See https://github.com/excalidraw/excalidraw/pull/1722#discussion_r436340171
+ */
+export declare const isRTL: (text: string) => boolean;
+export declare const tupleToCoors: (xyTuple: readonly [number, number]) => {
+    x: number;
+    y: number;
+};
+/** use as a rejectionHandler to mute filesystem Abort errors */
+export declare const muteFSAbortError: (error?: Error) => void;
+export declare const findIndex: <T>(array: readonly T[], cb: (element: T, index: number, array: readonly T[]) => boolean, fromIndex?: number) => number;
+export declare const findLastIndex: <T>(array: readonly T[], cb: (element: T, index: number, array: readonly T[]) => boolean, fromIndex?: number) => number;
+/** returns the first non-null mapped value */
+export declare const mapFind: <T, K>(collection: readonly T[], iteratee: (value: T, index: number) => K | undefined | null) => K | undefined;
+export declare const isTransparent: (color: string) => boolean;
+export type ResolvablePromise<T> = Promise<T> & {
+    resolve: [T] extends [undefined] ? (value?: MaybePromise<Awaited<T>>) => void : (value: MaybePromise<Awaited<T>>) => void;
+    reject: (error: Error) => void;
+};
+export declare const resolvablePromise: <T>() => ResolvablePromise<T>;
+export declare const nFormatter: (num: number, digits: number) => string;
+export declare const getVersion: () => string;
+export declare const supportsEmoji: () => boolean;
+export declare const getNearestScrollableContainer: (element: HTMLElement) => HTMLElement | Document;
+export declare const focusNearestParent: (element: HTMLInputElement) => void;
+export declare const preventUnload: (event: BeforeUnloadEvent) => void;
+export declare const bytesToHexString: (bytes: Uint8Array) => string;
+export declare const getUpdatedTimestamp: () => number;
+/**
+ * Transforms array of objects containing `id` attribute,
+ * or array of ids (strings), into a Map, keyd by `id`.
+ */
+export declare const arrayToMap: <T extends {
+    id: string;
+} | string>(items: readonly T[] | Map<string, T>) => Map<string, T>;
+export declare const arrayToMapWithIndex: <T extends {
+    id: string;
+}>(elements: readonly T[]) => Map<string, [element: T, index: number]>;
+/**
+ * Transform array into an object, use only when array order is irrelevant.
+ */
+export declare const arrayToObject: <T>(array: readonly T[], groupBy?: (value: T) => string | number) => {
+    [key: string]: T;
+};
+/** Doubly linked node */
+export type Node<T> = T & {
+    prev: Node<T> | null;
+    next: Node<T> | null;
+};
+/**
+ * Creates a circular doubly linked list by adding `prev` and `next` props to the existing array nodes.
+ */
+export declare const arrayToList: <T>(array: readonly T[]) => Node<T>[];
+/**
+ * Converts a readonly array or map into an iterable.
+ * Useful for avoiding entry allocations when iterating object / map on each iteration.
+ */
+export declare const toIterable: <T>(values: readonly T[] | ReadonlyMap<string, T>) => Iterable<T>;
+/**
+ * Converts a readonly array or map into an array.
+ */
+export declare const toArray: <T>(values: readonly T[] | ReadonlyMap<string, T>) => T[];
+export declare const isTestEnv: () => boolean;
+export declare const isDevEnv: () => boolean;
+export declare const isProdEnv: () => boolean;
+export declare const isServerEnv: () => boolean;
+export declare const wrapEvent: <T extends Event>(name: EVENT, nativeEvent: T) => CustomEvent<{
+    nativeEvent: T;
+}>;
+export declare const updateObject: <T extends Record<string, any>>(obj: T, updates: Partial<T>) => T;
+export declare const isPrimitive: (val: any) => boolean;
+export declare const getFrame: () => "top" | "iframe";
+export declare const isRunningInIframe: () => boolean;
+export declare const isPromiseLike: (value: any) => value is Promise<ResolutionType<typeof value>>;
+export declare const queryFocusableElements: (container: HTMLElement | null) => HTMLElement[];
+/**
+ * Returns whether object/array is shallow equal.
+ * Considers empty object/arrays as equal (whether top-level or second-level).
+ */
+export declare const isShallowEqual: <T extends Record<string, any>, K extends readonly unknown[]>(objA: T, objB: T, comparators?: { [key in keyof T]?: (a: T[key], b: T[key]) => boolean; } | (keyof T extends K[number] ? K extends readonly (keyof T)[] ? K : {
+    _error: "keys are either missing or include keys not in compared obj";
+} : {
+    _error: "keys are either missing or include keys not in compared obj";
+}), debug?: boolean) => boolean;
+export declare const composeEventHandlers: <E>(originalEventHandler?: (event: E) => void, ourEventHandler?: (event: E) => void, { checkForDefaultPrevented }?: {
+    checkForDefaultPrevented?: boolean | undefined;
+}) => (event: E) => void;
+/**
+ * supply `null` as message if non-never value is valid, you just need to
+ * typecheck against it
+ */
+export declare const assertNever: (value: never, message: string | null, softAssert?: boolean) => never;
+export declare function invariant(condition: any, message: string): asserts condition;
+/**
+ * Memoizes on values of `opts` object (strict equality).
+ */
+export declare const memoize: <T extends Record<string, any>, R extends any>(func: (opts: T) => R) => typeof func & {
+    clear: () => void;
+};
+/** Checks if value is inside given collection. Useful for type-safety. */
+export declare const isMemberOf: <T extends string>(
+/** Set/Map/Array/Object */
+collection: Set<T> | readonly T[] | Record<T, any> | Map<T, any>, 
+/** value to look for */
+value: string) => value is T;
+export declare const cloneJSON: <T>(obj: T) => T;
+export declare const updateStable: <T extends any[] | Record<string, any>>(prevValue: T, nextValue: T) => T;
+export declare function addEventListener<K extends keyof WindowEventMap>(target: Window & typeof globalThis, type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function addEventListener(target: Window & typeof globalThis, type: string, listener: (this: Window, ev: Event) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function addEventListener<K extends keyof DocumentEventMap>(target: Document, type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function addEventListener(target: Document, type: string, listener: (this: Document, ev: Event) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function addEventListener<K extends keyof FontFaceSetEventMap>(target: FontFaceSet, type: K, listener: (this: FontFaceSet, ev: FontFaceSetEventMap[K]) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function addEventListener<K extends keyof HTMLElementEventMap>(target: Document | (Window & typeof globalThis) | HTMLElement | undefined | null | false, type: K, listener: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): UnsubscribeCallback;
+export declare function getSvgPathFromStroke(points: number[][], closed?: boolean): string;
+export declare const normalizeEOL: (str: string) => string;
+export type HasBrand<T> = {
+    [K in keyof T]: K extends `~brand${infer _}` | "_brand" ? true : never;
+}[keyof T];
+type RemoveAllBrands<T> = HasBrand<T> extends true ? {
+    [K in keyof T as K extends `~brand~${infer _}` | "_brand" ? never : K]: T[K];
+} : T;
+type UnbrandForValue<T> = T extends Map<infer E, infer F> ? Map<UnbrandForValue<E>, UnbrandForValue<F>> : T extends Set<infer E> ? Set<UnbrandForValue<E>> : T extends readonly any[] ? T extends any[] ? unknown[] : readonly unknown[] : RemoveAllBrands<T>;
+export type Unbrand<T> = T extends Map<infer E, infer F> ? Map<Unbrand<E>, Unbrand<F>> : T extends Set<infer E> ? Set<Unbrand<E>> : T extends readonly (infer E)[] ? Array<Unbrand<E>> : RemoveAllBrands<T>;
+export type CombineBrands<BrandedType, CurrentType> = BrandedType extends readonly (infer BE)[] ? CurrentType extends readonly (infer CE)[] ? Array<CE & BE> : CurrentType & BrandedType : CurrentType & BrandedType;
+export type CombineBrandsIfNeeded<T, Required> = [T] extends [Required] ? T[] : HasBrand<T> extends true ? CombineBrands<T, Required>[] : Required[];
+/**
+ * Makes type into a branded type, ensuring that value is assignable to
+ * the base unbranded type. Optionally you can explicitly supply current value
+ * type to combine both (useful for composite branded types. Make sure you
+ * compose branded types which are not composite themselves.)
+ */
+export declare function toBrandedType<BrandedType>(value: UnbrandForValue<BrandedType>): BrandedType;
+export declare function toBrandedType<BrandedType, CurrentType>(value: CurrentType): CombineBrands<BrandedType, CurrentType>;
+export declare const promiseTry: <TValue, TArgs extends unknown[]>(fn: (...args: TArgs) => PromiseLike<TValue> | TValue, ...args: TArgs) => Promise<TValue>;
+export declare const isAnyTrue: (...args: boolean[]) => boolean;
+export declare const safelyParseJSON: (json: string) => Record<string, any> | null;
+/**
+ * use when you need to render unsafe string as HTML attribute, but MAKE SURE
+ * the attribute is double-quoted when constructing the HTML string
+ */
+export declare const escapeDoubleQuotes: (str: string) => string;
+export declare const castArray: <T>(value: T | T[]) => T[];
+/** hack for Array.isArray type guard not working with readonly value[] */
+export declare const isReadonlyArray: (value?: any) => value is readonly any[];
+export declare const sizeOf: (value: readonly unknown[] | Readonly<Map<string, unknown>> | Readonly<Record<string, unknown>> | ReadonlySet<unknown>) => number;
+export declare const reduceToCommonValue: <T, R = T>(collection: readonly T[] | ReadonlySet<T>, getValue?: (item: T) => R) => R | null;
+type FEATURE_FLAGS = {
+    COMPLEX_BINDINGS: boolean;
+};
+export declare const getFeatureFlag: <F extends keyof FEATURE_FLAGS>(flag: F) => FEATURE_FLAGS[F];
+export declare const setFeatureFlag: <F extends keyof FEATURE_FLAGS>(flag: F, value: FEATURE_FLAGS[F]) => void;
+export {};

package/dist/types/common/src/visualdebug.d.ts

@@ -0,0 +1,41 @@
+import { type GlobalPoint, type LocalPoint } from "@excalidraw/math";
+import type { Curve } from "@excalidraw/math";
+import type { LineSegment } from "@excalidraw/utils";
+import { type Bounds } from "./bounds";
+declare global {
+    interface Window {
+        visualDebug?: {
+            data: DebugElement[][];
+            currentFrame?: number;
+        };
+    }
+}
+export type DebugElement = {
+    color: string;
+    data: LineSegment<GlobalPoint> | Curve<GlobalPoint>;
+    permanent: boolean;
+};
+export declare const debugDrawCubicBezier: (c: Curve<GlobalPoint>, opts?: {
+    color?: string;
+    permanent?: boolean;
+}) => void;
+export declare const debugDrawLine: (segment: LineSegment<GlobalPoint> | LineSegment<GlobalPoint>[], opts?: {
+    color?: string;
+    permanent?: boolean;
+}) => void;
+export declare const debugDrawPoint: (p: GlobalPoint, opts?: {
+    color?: string;
+    permanent?: boolean;
+    fuzzy?: boolean;
+}) => void;
+export declare const debugDrawBounds: (box: Bounds | Bounds[], opts?: {
+    color?: string;
+    permanent?: boolean;
+}) => void;
+export declare const debugDrawPoints: ({ x, y, points, }: {
+    x: number;
+    y: number;
+    points: readonly LocalPoint[];
+}, options?: any) => void;
+export declare const debugCloseFrame: () => void;
+export declare const debugClear: () => void;