@myoc/excalidraw 0.18.1

package/dist/types/excalidraw/utility-types.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+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;

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

@@ -0,0 +1,256 @@
+import type { EVENT } from "./constants";
+import type { ExcalidrawBindableElement, FontFamilyValues, FontString } from "./element/types";
+import type { ActiveTool, AppState, ToolType, UnsubscribeCallback, Zoom } from "./types";
+import type { MaybePromise } from "./utility-types";
+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;
+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, progress: number, key: K) => number | undefined) | undefined;
+    onStep: (values: T) => void;
+    duration?: number | undefined;
+    onStart?: (() => void) | undefined;
+    onEnd?: (() => void) | undefined;
+    onCancel?: (() => void) | undefined;
+}) => () => void;
+export declare const chunk: <T extends unknown>(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 updateActiveTool: (appState: Pick<AppState, "activeTool">, data: (({
+    type: ToolType;
+} | {
+    type: "custom";
+    customType: string;
+}) & {
+    locked?: 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 getShortcutKey: (shortcut: string) => string;
+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;
+export declare const isTransparent: (color: string) => boolean;
+export declare const isBindingFallthroughEnabled: (el: ExcalidrawBindableElement) => 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 string | {
+    id: string;
+}>(items: Map<string, T> | readonly 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) | undefined) => {
+    [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>[];
+export declare const isTestEnv: () => boolean;
+export declare const isDevEnv: () => 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<any>;
+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) | undefined; } | (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";
+}) | undefined, debug?: boolean) => boolean;
+export declare const composeEventHandlers: <E>(originalEventHandler?: ((event: E) => void) | undefined, ourEventHandler?: ((event: E) => void) | undefined, { 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 unknown>(func: (opts: T) => R) => ((opts: T) => R) & {
+    clear: () => void;
+};
+/** Checks if value is inside given collection. Useful for type-safety. */
+export declare const isMemberOf: <T extends string>(collection: Set<T> | Record<T, any> | Map<T, any> | readonly T[], 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;
+type HasBrand<T> = {
+    [K in keyof T]: K extends `~brand${infer _}` ? true : never;
+}[keyof T];
+type RemoveAllBrands<T> = HasBrand<T> extends true ? {
+    [K in keyof T as K extends `~brand~${infer _}` ? never : K]: T[K];
+} : never;
+type Unbrand<T> = T extends Map<infer E, infer F> ? Map<E, F> : T extends Set<infer E> ? Set<E> : T extends Array<infer E> ? Array<E> : RemoveAllBrands<T>;
+/**
+ * Makes type into a branded type, ensuring that value is assignable to
+ * the base ubranded 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 const toBrandedType: <BrandedType, CurrentType = BrandedType>(value: Unbrand<BrandedType>) => CurrentType & BrandedType;
+export declare const promiseTry: <TValue, TArgs extends unknown[]>(fn: (...args: TArgs) => TValue | PromiseLike<TValue>, ...args: TArgs) => Promise<TValue>;
+export declare const isAnyTrue: (...args: boolean[]) => boolean;
+export declare const safelyParseJSON: (json: string) => Record<string, any> | null;
+export declare class PromisePool<T> {
+    private readonly pool;
+    private readonly entries;
+    constructor(source: IterableIterator<Promise<void | readonly [number, T]>>, concurrency: number);
+    all(): PromiseLike<T[]>;
+}
+/**
+ * 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[];
+export {};

package/dist/types/excalidraw/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 "./element/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: LocalPoint[];
+}, options?: any) => void;
+export declare const debugCloseFrame: () => void;
+export declare const debugClear: () => void;

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

@@ -0,0 +1,36 @@
+/**
+ * Pool of idle short-lived workers.
+ *
+ * IMPORTANT: for simplicity it does not limit the number of newly created workers, leaving it up to the caller to manage the pool size.
+ */
+export declare class WorkerPool<T, R> {
+    private idleWorkers;
+    private readonly workerUrl;
+    private readonly workerTTL;
+    private constructor();
+    /**
+     * Create a new worker pool.
+     *
+     * @param workerUrl - The URL of the worker file.
+     * @param options - The options for the worker pool.
+     * @throws If the worker is bundled into the main chunk.
+     * @returns A new worker pool instance.
+     */
+    static create<T, R>(workerUrl: URL | undefined, options?: {
+        ttl?: number;
+    }): WorkerPool<T, R>;
+    /**
+     * Take idle worker from the pool or create a new one and post a message to it.
+     */
+    postMessage(data: T, options: StructuredSerializeOptions): Promise<R>;
+    /**
+     * Terminate the idle workers in the pool.
+     */
+    clear(): Promise<void>;
+    /**
+     * Used to get a worker from the pool or create a new one if there is no idle available.
+     */
+    private createWorker;
+    private onMessageHandler;
+    private onErrorHandler;
+}

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

@@ -0,0 +1,6 @@
+import type { ExcalidrawElement } from "./element/types";
+import type { AppState } from "./types";
+export declare const moveOneLeft: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[];
+export declare const moveOneRight: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[];
+export declare const moveAllLeft: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[] | ExcalidrawElement[];
+export declare const moveAllRight: (allElements: readonly ExcalidrawElement[], appState: AppState) => readonly ExcalidrawElement[] | ExcalidrawElement[];

package/dist/types/math/angle.d.ts

@@ -0,0 +1,17 @@
+import type { Degrees, GlobalPoint, LocalPoint, PolarCoords, Radians } from "./types";
+export declare const normalizeRadians: (angle: Radians) => Radians;
+/**
+ * Return the polar coordinates for the given cartesian point represented by
+ * (x, y) for the center point 0,0 where the first number returned is the radius,
+ * the second is the angle in radians.
+ */
+export declare const cartesian2Polar: <P extends GlobalPoint | LocalPoint>([x, y,]: P) => PolarCoords;
+export declare function degreesToRadians(degrees: Degrees): Radians;
+export declare function radiansToDegrees(degrees: Radians): Degrees;
+/**
+ * Determines if the provided angle is a right angle.
+ *
+ * @param rads The angle to measure
+ * @returns TRUE if the provided angle is a right angle
+ */
+export declare function isRightAngleRads(rads: Radians): boolean;

package/dist/types/math/curve.d.ts

@@ -0,0 +1,40 @@
+import type { Curve, GlobalPoint, LineSegment, LocalPoint } from "./types";
+/**
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ * @returns
+ */
+export declare function curve<Point extends GlobalPoint | LocalPoint>(a: Point, b: Point, c: Point, d: Point): Curve<Point>;
+/**
+ * Computes the intersection between a cubic spline and a line segment.
+ */
+export declare function curveIntersectLineSegment<Point extends GlobalPoint | LocalPoint>(c: Curve<Point>, l: LineSegment<Point>): Point[];
+/**
+ * Finds the closest point on the Bezier curve from another point
+ *
+ * @param x
+ * @param y
+ * @param P0
+ * @param P1
+ * @param P2
+ * @param P3
+ * @param tolerance
+ * @param maxLevel
+ * @returns
+ */
+export declare function curveClosestPoint<Point extends GlobalPoint | LocalPoint>(c: Curve<Point>, p: Point, tolerance?: number): Point | null;
+/**
+ * Determines the distance between a point and the closest point on the
+ * Bezier curve.
+ *
+ * @param c The curve to test
+ * @param p The point to measure from
+ */
+export declare function curvePointDistance<Point extends GlobalPoint | LocalPoint>(c: Curve<Point>, p: Point): number;
+/**
+ * Determines if the parameter is a Curve
+ */
+export declare function isCurve<P extends GlobalPoint | LocalPoint>(v: unknown): v is Curve<P>;

package/dist/types/math/ellipse.d.ts

@@ -0,0 +1,44 @@
+import type { Ellipse, GlobalPoint, Line, LineSegment, LocalPoint } from "./types";
+/**
+ * Construct an Ellipse object from the parameters
+ *
+ * @param center The center of the ellipse
+ * @param angle The slanting of the ellipse in radians
+ * @param halfWidth Half of the width of a non-slanted version of the ellipse
+ * @param halfHeight Half of the height of a non-slanted version of the ellipse
+ * @returns The constructed Ellipse object
+ */
+export declare function ellipse<Point extends GlobalPoint | LocalPoint>(center: Point, halfWidth: number, halfHeight: number): Ellipse<Point>;
+/**
+ * Determines if a point is inside or on the ellipse outline
+ *
+ * @param p The point to test
+ * @param ellipse The ellipse to compare against
+ * @returns TRUE if the point is inside or on the outline of the ellipse
+ */
+export declare const ellipseIncludesPoint: <Point extends GlobalPoint | LocalPoint>(p: Point, ellipse: Ellipse<Point>) => boolean;
+/**
+ * Tests whether a point lies on the outline of the ellipse within a given
+ * tolerance
+ *
+ * @param point The point to test
+ * @param ellipse The ellipse to compare against
+ * @param threshold The distance to consider a point close enough to be "on" the outline
+ * @returns TRUE if the point is on the ellise outline
+ */
+export declare const ellipseTouchesPoint: <Point extends GlobalPoint | LocalPoint>(point: Point, ellipse: Ellipse<Point>, threshold?: number) => boolean;
+/**
+ * Determine the shortest euclidean distance from a point to the
+ * outline of the ellipse
+ *
+ * @param p The point to consider
+ * @param ellipse The ellipse to calculate the distance to
+ * @returns The eucledian distance
+ */
+export declare const ellipseDistanceFromPoint: <Point extends GlobalPoint | LocalPoint>(p: Point, ellipse: Ellipse<Point>) => number;
+/**
+ * Calculate a maximum of two intercept points for a line going throug an
+ * ellipse.
+ */
+export declare function ellipseSegmentInterceptPoints<Point extends GlobalPoint | LocalPoint>(e: Readonly<Ellipse<Point>>, s: Readonly<LineSegment<Point>>): Point[];
+export declare function ellipseLineIntersectionPoints<Point extends GlobalPoint | LocalPoint>({ center, halfWidth, halfHeight }: Ellipse<Point>, [g, h]: Line<Point>): Point[];

package/dist/types/math/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./angle";
+export * from "./curve";
+export * from "./line";
+export * from "./point";
+export * from "./polygon";
+export * from "./range";
+export * from "./rectangle";
+export * from "./segment";
+export * from "./triangle";
+export * from "./types";
+export * from "./vector";
+export * from "./utils";

package/dist/types/math/line.d.ts

@@ -0,0 +1,17 @@
+import type { GlobalPoint, Line, LocalPoint } from "./types";
+/**
+ * Create a line from two points.
+ *
+ * @param points The two points lying on the line
+ * @returns The line on which the points lie
+ */
+export declare function line<P extends GlobalPoint | LocalPoint>(a: P, b: P): Line<P>;
+/**
+ * Determines the intersection point (unless the lines are parallel) of two
+ * lines
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function linesIntersectAt<Point extends GlobalPoint | LocalPoint>(a: Line<Point>, b: Line<Point>): Point | null;

package/dist/types/math/point.d.ts

@@ -0,0 +1,122 @@
+import type { LocalPoint, GlobalPoint, Radians, Degrees, Vector } from "./types";
+/**
+ * Create a properly typed Point instance from the X and Y coordinates.
+ *
+ * @param x The X coordinate
+ * @param y The Y coordinate
+ * @returns The branded and created point
+ */
+export declare function pointFrom<Point extends GlobalPoint | LocalPoint>(x: number, y: number): Point;
+/**
+ * Converts and remaps an array containing a pair of numbers to Point.
+ *
+ * @param numberArray The number array to check and to convert to Point
+ * @returns The point instance
+ */
+export declare function pointFromArray<Point extends GlobalPoint | LocalPoint>(numberArray: number[]): Point | undefined;
+/**
+ * Converts and remaps a pair of numbers to Point.
+ *
+ * @param pair A number pair to convert to Point
+ * @returns The point instance
+ */
+export declare function pointFromPair<Point extends GlobalPoint | LocalPoint>(pair: [number, number]): Point;
+/**
+ * Convert a vector to a point.
+ *
+ * @param v The vector to convert
+ * @returns The point the vector points at with origin 0,0
+ */
+export declare function pointFromVector<P extends GlobalPoint | LocalPoint>(v: Vector, offset?: P): P;
+/**
+ * Checks if the provided value has the shape of a Point.
+ *
+ * @param p The value to attempt verification on
+ * @returns TRUE if the provided value has the shape of a local or global point
+ */
+export declare function isPoint(p: unknown): p is LocalPoint | GlobalPoint;
+/**
+ * Compare two points coordinate-by-coordinate and if
+ * they are closer than INVERSE_PRECISION it returns TRUE.
+ *
+ * @param a Point The first point to compare
+ * @param b Point The second point to compare
+ * @returns TRUE if the points are sufficiently close to each other
+ */
+export declare function pointsEqual<Point extends GlobalPoint | LocalPoint>(a: Point, b: Point): boolean;
+/**
+ * Roate a point by [angle] radians.
+ *
+ * @param point The point to rotate
+ * @param center The point to rotate around, the center point
+ * @param angle The radians to rotate the point by
+ * @returns The rotated point
+ */
+export declare function pointRotateRads<Point extends GlobalPoint | LocalPoint>([x, y]: Point, [cx, cy]: Point, angle: Radians): Point;
+/**
+ * Roate a point by [angle] degree.
+ *
+ * @param point The point to rotate
+ * @param center The point to rotate around, the center point
+ * @param angle The degree to rotate the point by
+ * @returns The rotated point
+ */
+export declare function pointRotateDegs<Point extends GlobalPoint | LocalPoint>(point: Point, center: Point, angle: Degrees): Point;
+/**
+ * Translate a point by a vector.
+ *
+ * WARNING: This is not for translating Excalidraw element points!
+ *          You need to account for rotation on base coordinates
+ *          on your own.
+ *          CONSIDER USING AN APPROPRIATE ELEMENT-AWARE TRANSLATE!
+ *
+ * @param p The point to apply the translation on
+ * @param v The vector to translate by
+ * @returns
+ */
+export declare function pointTranslate<From extends GlobalPoint | LocalPoint, To extends GlobalPoint | LocalPoint>(p: From, v?: Vector): To;
+/**
+ * Find the center point at equal distance from both points.
+ *
+ * @param a One of the points to create the middle point for
+ * @param b The other point to create the middle point for
+ * @returns The middle point
+ */
+export declare function pointCenter<P extends LocalPoint | GlobalPoint>(a: P, b: P): P;
+/**
+ * Calculate the distance between two points.
+ *
+ * @param a First point
+ * @param b Second point
+ * @returns The euclidean distance between the two points.
+ */
+export declare function pointDistance<P extends LocalPoint | GlobalPoint>(a: P, b: P): number;
+/**
+ * Calculate the squared distance between two points.
+ *
+ * Note: Use this if you only compare distances, it saves a square root.
+ *
+ * @param a First point
+ * @param b Second point
+ * @returns The euclidean distance between the two points.
+ */
+export declare function pointDistanceSq<P extends LocalPoint | GlobalPoint>(a: P, b: P): number;
+/**
+ * Scale a point from a given origin by the multiplier.
+ *
+ * @param p The point to scale
+ * @param mid The origin to scale from
+ * @param multiplier The scaling factor
+ * @returns
+ */
+export declare const pointScaleFromOrigin: <P extends GlobalPoint | LocalPoint>(p: P, mid: P, multiplier: number) => GlobalPoint | LocalPoint;
+/**
+ * Returns whether `q` lies inside the segment/rectangle defined by `p` and `r`.
+ * This is an approximation to "does `q` lie on a segment `pr`" check.
+ *
+ * @param p The first point to compare against
+ * @param q The actual point this function checks whether is in between
+ * @param r The other point to compare against
+ * @returns TRUE if q is indeed between p and r
+ */
+export declare const isPointWithinBounds: <P extends GlobalPoint | LocalPoint>(p: P, q: P, r: P) => boolean;

package/dist/types/math/polygon.d.ts

@@ -0,0 +1,5 @@
+import type { GlobalPoint, LocalPoint, Polygon } from "./types";
+export declare function polygon<Point extends GlobalPoint | LocalPoint>(...points: Point[]): Polygon<Point>;
+export declare function polygonFromPoints<Point extends GlobalPoint | LocalPoint>(points: Point[]): Polygon<Point>;
+export declare const polygonIncludesPoint: <Point extends GlobalPoint | LocalPoint>(point: Point, polygon: Polygon<Point>) => boolean;
+export declare const pointOnPolygon: <Point extends GlobalPoint | LocalPoint>(p: Point, poly: Polygon<Point>, threshold?: number) => boolean;