@tldraw/editor 4.2.0-next.f100cedfc45b → 4.3.0-canary.03ae87dcc44b

package/dist-cjs/index.d.ts

@@ -7,6 +7,7 @@ import { Editor as Editor_2 } from '@tiptap/core';
 import { EditorProviderProps as EditorProviderProps_2 } from '@tiptap/react';
 import EventEmitter from 'eventemitter3';
 import { ExoticComponent } from 'react';
+import { ExtractShapeByProps } from '@tldraw/tlschema';
 import { ForwardRefExoticComponent } from 'react';
 import { HistoryEntry } from '@tldraw/store';
 import { IndexKey } from '@tldraw/utils';
@@ -48,6 +49,7 @@ import { TLBindingId } from '@tldraw/tlschema';
 import { TLBindingUpdate } from '@tldraw/tlschema';
 import { TLBookmarkAsset } from '@tldraw/tlschema';
 import { TLCamera } from '@tldraw/tlschema';
+import { TLCreateShapePartial } from '@tldraw/tlschema';
 import { TLCursor } from '@tldraw/tlschema';
 import { TLCursorType } from '@tldraw/tlschema';
 import { TLDefaultDashStyle } from '@tldraw/tlschema';
@@ -147,7 +149,7 @@ export declare abstract class BaseBoxShapeTool extends StateNode {
     static id: string;
     static initial: string;
     static children(): TLStateNodeConstructor[];
-    abstract shapeType: string;
+    abstract shapeType: TLBaseBoxShape['type'];
     onCreate?(_shape: null | TLShape): null | void;
 }
 
@@ -165,7 +167,7 @@ export declare abstract class BaseBoxShapeUtil<Shape extends TLBaseBoxShape> ext
  *
  * @public
  */
-export declare interface BindingOnChangeOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnChangeOptions<Binding extends TLBinding = TLBinding> {
     /** The binding record before the change is made. */
     bindingBefore: Binding;
     /** The binding record after the change is made. */
@@ -178,7 +180,7 @@ export declare interface BindingOnChangeOptions<Binding extends TLUnknownBinding
  *
  * @public
  */
-export declare interface BindingOnCreateOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnCreateOptions<Binding extends TLBinding = TLBinding> {
     /** The binding being created. */
     binding: Binding;
 }
@@ -189,7 +191,7 @@ export declare interface BindingOnCreateOptions<Binding extends TLUnknownBinding
  *
  * @public
  */
-export declare interface BindingOnDeleteOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnDeleteOptions<Binding extends TLBinding = TLBinding> {
     /** The binding being deleted. */
     binding: Binding;
 }
@@ -200,7 +202,7 @@ export declare interface BindingOnDeleteOptions<Binding extends TLUnknownBinding
  *
  * @public
  */
-export declare interface BindingOnShapeChangeOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnShapeChangeOptions<Binding extends TLBinding = TLBinding> {
     /** The binding record linking these two shapes. */
     binding: Binding;
     /** The shape record before the change is made. */
@@ -224,7 +226,7 @@ export declare interface BindingOnShapeChangeOptions<Binding extends TLUnknownBi
  *
  * @public
  */
-export declare interface BindingOnShapeDeleteOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnShapeDeleteOptions<Binding extends TLBinding = TLBinding> {
     /** The binding record that refers to the shape in question. */
     binding: Binding;
     /** The shape that is about to be deleted. */
@@ -256,7 +258,7 @@ export declare interface BindingOnShapeDeleteOptions<Binding extends TLUnknownBi
  *
  * @public
  */
-export declare interface BindingOnShapeIsolateOptions<Binding extends TLUnknownBinding> {
+export declare interface BindingOnShapeIsolateOptions<Binding extends TLBinding = TLBinding> {
     /** The binding record that refers to the shape in question. */
     binding: Binding;
     /**
@@ -267,7 +269,7 @@ export declare interface BindingOnShapeIsolateOptions<Binding extends TLUnknownB
 }
 
 /** @public */
-export declare abstract class BindingUtil<Binding extends TLUnknownBinding = TLUnknownBinding> {
+export declare abstract class BindingUtil<Binding extends TLBinding = TLBinding> {
     editor: Editor;
     constructor(editor: Editor);
     static props?: RecordProps<TLUnknownBinding>;
@@ -1023,19 +1025,21 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * after the editor has already been initialized.
      *
      * @param Tool - The tool to set.
+     * @param parent - The parent state node to set the tool on.
      *
      * @public
      */
-    setTool(Tool: TLStateNodeConstructor): void;
+    setTool(Tool: TLStateNodeConstructor, parent?: StateNode): void;
     /**
      * Remove a tool. Useful if you need to remove a tool from the state chart on demand,
      * after the editor has already been initialized.
      *
      * @param Tool - The tool to delete.
+     * @param parent - The parent state node to remove the tool from.
      *
      * @public
      */
-    removeTool(Tool: TLStateNodeConstructor): void;
+    removeTool(Tool: TLStateNodeConstructor, parent?: StateNode): void;
     /**
      * A set of functions to call when the app is disposed.
      *
@@ -1127,7 +1131,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     shapeUtils: {
-        readonly [K in string]?: ShapeUtil<TLUnknownShape>;
+        readonly [K in string]?: ShapeUtil<TLShape>;
     };
     styleProps: {
         [key: string]: Map<StyleProp<any>, string>;
@@ -1147,16 +1151,18 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    getShapeUtil<S extends TLUnknownShape>(shape: S | TLShapePartial<S>): ShapeUtil<S>;
-    getShapeUtil<S extends TLUnknownShape>(type: S['type']): ShapeUtil<S>;
+    getShapeUtil<K extends TLShape['type']>(type: K): ShapeUtil<Extract<TLShape, {
+        type: K;
+    }>>;
+    getShapeUtil<S extends TLShape>(shape: S | S['type'] | TLShapePartial<S>): ShapeUtil<S>;
     getShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): T;
     /**
      * Returns true if the editor has a shape util for the given shape / shape type.
      *
      * @param shape - A shape, shape partial, or shape type.
      */
-    hasShapeUtil<S extends TLUnknownShape>(shape: S | TLShapePartial<S>): boolean;
-    hasShapeUtil<S extends TLUnknownShape>(type: S['type']): boolean;
+    hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
+    hasShapeUtil(type: TLShape['type']): boolean;
     hasShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): boolean;
     /**
      * A map of shape utility classes (TLShapeUtils) by shape type.
@@ -1164,7 +1170,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     bindingUtils: {
-        readonly [K in string]?: BindingUtil<TLUnknownBinding>;
+        readonly [K in string]?: BindingUtil<TLBinding>;
     };
     /**
      * Get a binding util from a binding itself.
@@ -1181,10 +1187,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    getBindingUtil<S extends TLUnknownBinding>(binding: {
+    getBindingUtil<K extends TLBinding['type']>(type: K): BindingUtil<Extract<TLBinding, {
+        type: K;
+    }>>;
+    getBindingUtil<S extends TLBinding>(binding: {
         type: S['type'];
     } | S): BindingUtil<S>;
-    getBindingUtil<S extends TLUnknownBinding>(type: S['type']): BindingUtil<S>;
     getBindingUtil<T extends BindingUtil>(type: T extends BindingUtil<infer R> ? R['type'] : string): T;
     /**
      * A manager for the app's history.
@@ -2763,7 +2771,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @example
      * ```ts
-     * const isArrowShape = isShapeOfType<TLArrowShape>(someShape, 'arrow')
+     * const isArrowShape = isShapeOfType(someShape, 'arrow')
      * ```
      *
      * @param util - the TLShapeUtil constructor to test against
@@ -2771,8 +2779,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    isShapeOfType<T extends TLUnknownShape>(shape: TLUnknownShape, type: T['type']): shape is T;
-    isShapeOfType<T extends TLUnknownShape>(shapeId: TLUnknownShape['id'], type: T['type']): shapeId is T['id'];
+    isShapeOfType<K extends TLShape['type']>(shape: TLShape, type: K): shape is Extract<TLShape, {
+        type: K;
+    }>;
+    isShapeOfType<T extends TLShape>(shape: TLShape, type: T['type']): shape is Extract<TLShape, {
+        type: T['type'];
+    }>;
+    isShapeOfType<T extends TLShape = TLShape>(shapeId: TLShapeId, type: T['type']): boolean;
     /**
      * Get a shape by its id.
      *
@@ -2923,17 +2936,26 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * Get all bindings of a certain type _from_ a particular shape. These are the bindings whose
      * `fromId` matched the shape's ID.
      */
-    getBindingsFromShape<Binding extends TLUnknownBinding = TLBinding>(shape: TLShape | TLShapeId, type: Binding['type']): Binding[];
+    getBindingsFromShape<K extends TLBinding['type']>(shape: TLShape | TLShapeId, type: K): Extract<TLBinding, {
+        type: K;
+    }>[];
+    getBindingsFromShape<Binding extends TLBinding = TLBinding>(shape: TLShape | TLShapeId, type: Binding['type']): Binding[];
     /**
      * Get all bindings of a certain type _to_ a particular shape. These are the bindings whose
      * `toId` matches the shape's ID.
      */
-    getBindingsToShape<Binding extends TLUnknownBinding = TLBinding>(shape: TLShape | TLShapeId, type: Binding['type']): Binding[];
+    getBindingsToShape<K extends TLBinding['type']>(shape: TLShape | TLShapeId, type: K): Extract<TLBinding, {
+        type: K;
+    }>[];
+    getBindingsToShape<Binding extends TLBinding = TLBinding>(shape: TLShape | TLShapeId, type: Binding['type']): Binding[];
     /**
      * Get all bindings involving a particular shape. This includes bindings where the shape is the
      * `fromId` or `toId`. If a type is provided, only bindings of that type are returned.
      */
-    getBindingsInvolvingShape<Binding extends TLUnknownBinding = TLBinding>(shape: TLShape | TLShapeId, type?: Binding['type']): Binding[];
+    getBindingsInvolvingShape<K extends TLBinding['type']>(shape: TLShape | TLShapeId, type: K): Extract<TLBinding, {
+        type: K;
+    }>[];
+    getBindingsInvolvingShape<Binding extends TLBinding = TLBinding>(shape: TLShape | TLShapeId, type?: Binding['type']): Binding[];
     /**
      * Create bindings from a list of partial bindings. You can omit the ID and most props of a
      * binding, but the `type`, `toId`, and `fromId` must all be provided.
@@ -3248,7 +3270,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    canCreateShape<T extends TLUnknownShape>(shape: OptionalKeys<TLShapePartial<T>, 'id'> | T['id']): boolean;
+    canCreateShape(shape: OptionalKeys<TLShapePartial<TLShape>, 'id'> | TLShape['id']): boolean;
     /**
      * Get whether the provided shapes can be created.
      *
@@ -3256,7 +3278,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    canCreateShapes<T extends TLUnknownShape>(shapes: (OptionalKeys<TLShapePartial<T>, 'id'> | T['id'])[]): boolean;
+    canCreateShapes(shapes: (OptionalKeys<TLShapePartial<TLShape>, 'id'> | TLShape['id'])[]): boolean;
     /**
      * Create a single shape.
      *
@@ -3270,7 +3292,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    createShape<T extends TLUnknownShape>(shape: OptionalKeys<TLShapePartial<T>, 'id'>): this;
+    createShape<TShape extends TLShape>(shape: TLCreateShapePartial<TShape>): this;
     /**
      * Create shapes.
      *
@@ -3284,7 +3306,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    createShapes<T extends TLUnknownShape>(shapes: OptionalKeys<TLShapePartial<T>, 'id'>[]): this;
+    createShapes<TShape extends TLShape = TLShape>(shapes: TLCreateShapePartial<TShape>[]): this;
     private animatingShapes;
     /**
      * Animate a shape.
@@ -3370,7 +3392,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    updateShape<T extends TLUnknownShape>(partial: null | TLShapePartial<T> | undefined): this;
+    updateShape<T extends TLShape = TLShape>(partial: null | TLShapePartial<T> | undefined): this;
     /**
      * Update shapes using partials of each shape.
      *
@@ -3383,7 +3405,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    updateShapes<T extends TLUnknownShape>(partials: (null | TLShapePartial<T> | undefined)[]): this;
+    updateShapes<T extends TLShape>(partials: (null | TLShapePartial<T> | undefined)[]): this;
     /* Excluded from this release type: _updateShapes */
     /* Excluded from this release type: _getUnlockedShapeIds */
     /**
@@ -5114,7 +5136,7 @@ export declare function setRuntimeOverrides(input: Partial<typeof runtime>): voi
 export declare function setUserPreferences(user: TLUserPreferences): void;
 
 /** @public */
-export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
+export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
     editor: Editor;
     /** Configure this shape utils {@link ShapeUtil.options | `options`}. */
     static configure<T extends TLShapeUtilConstructor<any, any>>(this: T, options: T extends new (...args: any[]) => {
@@ -6039,7 +6061,7 @@ export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
 export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
 
 /** @public */
-export declare type TLBaseBoxShape = TLBaseShape<string, {
+export declare type TLBaseBoxShape = ExtractShapeByProps<{
     h: number;
     w: number;
 }>;
@@ -6061,7 +6083,7 @@ export declare interface TLBaseExternalContent {
 }
 
 /** @public */
-export declare interface TLBindingUtilConstructor<T extends TLUnknownBinding, U extends BindingUtil<T> = BindingUtil<T>> {
+export declare interface TLBindingUtilConstructor<T extends TLBinding, U extends BindingUtil<T> = BindingUtil<T>> {
     new (editor: Editor): U;
     type: T['type'];
     /** Validations for this binding's props. */
@@ -7495,11 +7517,11 @@ export declare interface TLShapeUtilCanBeLaidOutOpts {
  *
  * @public
  */
-export declare interface TLShapeUtilCanBindOpts<Shape extends TLUnknownShape = TLUnknownShape> {
+export declare interface TLShapeUtilCanBindOpts<Shape extends TLShape = TLShape> {
     /** The type of shape referenced by the `fromId` of the binding. */
-    fromShapeType: string;
+    fromShapeType: TLShape['type'];
     /** The type of shape referenced by the `toId` of the binding. */
-    toShapeType: string;
+    toShapeType: TLShape['type'];
     /** The type of binding. */
     bindingType: string;
 }
@@ -7511,7 +7533,7 @@ export declare interface TLShapeUtilCanvasSvgDef {
 }
 
 /** @public */
-export declare interface TLShapeUtilConstructor<T extends TLUnknownShape, U extends ShapeUtil<T> = ShapeUtil<T>> {
+export declare interface TLShapeUtilConstructor<T extends TLShape, U extends ShapeUtil<T> = ShapeUtil<T>> {
     new (editor: Editor): U;
     type: T['type'];
     props?: RecordProps<T>;

package/dist-cjs/index.js

@@ -370,7 +370,7 @@ var import_uniq = require("./lib/utils/uniq");
 var import_window_open = require("./lib/utils/window-open");
 (0, import_utils.registerTldrawLibraryVersion)(
   "@tldraw/editor",
-  "4.2.0-next.f100cedfc45b",
+  "4.3.0-canary.03ae87dcc44b",
   "cjs"
 );
 //# sourceMappingURL=index.js.map

package/dist-cjs/lib/editor/Editor.js

@@ -824,26 +824,30 @@ class Editor extends (_a = import_eventemitter3.default, _getIsShapeHiddenCache_
    * after the editor has already been initialized.
    *
    * @param Tool - The tool to set.
+   * @param parent - The parent state node to set the tool on.
    *
    * @public
    */
-  setTool(Tool) {
-    if ((0, import_utils.hasOwnProperty)(this.root.children, Tool.id)) {
+  setTool(Tool, parent) {
+    parent ??= this.root;
+    if ((0, import_utils.hasOwnProperty)(parent.children, Tool.id)) {
       throw Error(`Can't override tool with id "${Tool.id}"`);
     }
-    this.root.children[Tool.id] = new Tool(this, this.root);
+    parent.children[Tool.id] = new Tool(this, parent);
   }
   /**
    * Remove a tool. Useful if you need to remove a tool from the state chart on demand,
    * after the editor has already been initialized.
    *
    * @param Tool - The tool to delete.
+   * @param parent - The parent state node to remove the tool from.
    *
    * @public
    */
-  removeTool(Tool) {
-    if ((0, import_utils.hasOwnProperty)(this.root.children, Tool.id)) {
-      delete this.root.children[Tool.id];
+  removeTool(Tool, parent) {
+    parent ??= this.root;
+    if ((0, import_utils.hasOwnProperty)(parent.children, Tool.id)) {
+      delete parent.children[Tool.id];
     }
   }
   /**
@@ -4396,30 +4400,18 @@ class Editor extends (_a = import_eventemitter3.default, _getIsShapeHiddenCache_
   getBinding(id) {
     return this.store.get(id);
   }
-  /**
-   * Get all bindings of a certain type _from_ a particular shape. These are the bindings whose
-   * `fromId` matched the shape's ID.
-   */
   getBindingsFromShape(shape, type) {
     const id = typeof shape === "string" ? shape : shape.id;
     return this.getBindingsInvolvingShape(id).filter(
       (b) => b.fromId === id && b.type === type
     );
   }
-  /**
-   * Get all bindings of a certain type _to_ a particular shape. These are the bindings whose
-   * `toId` matches the shape's ID.
-   */
   getBindingsToShape(shape, type) {
     const id = typeof shape === "string" ? shape : shape.id;
     return this.getBindingsInvolvingShape(id).filter(
       (b) => b.toId === id && b.type === type
     );
   }
-  /**
-   * Get all bindings involving a particular shape. This includes bindings where the shape is the
-   * `fromId` or `toId`. If a type is provided, only bindings of that type are returned.
-   */
   getBindingsInvolvingShape(shape, type) {
     const id = typeof shape === "string" ? shape : shape.id;
     const result = this._getBindingsIndexCache().get(id) ?? import_state.EMPTY_ARRAY;
@@ -7477,6 +7469,7 @@ class Editor extends (_a = import_eventemitter3.default, _getIsShapeHiddenCache_
           this.setCursor({ type: this._prevCursor, rotation: 0 });
         }
       }
+      this.emit("event", info);
       this.root.handleEvent(info);
       return;
     }