@tldraw/tlschema 4.1.0-canary.e23ee15a46bc → 4.1.0-canary.e259b517a450

package/dist-cjs/index.d.ts

@@ -4318,8 +4318,12 @@ export declare interface TLHandle {
     label?: string;
     /** The type of handle, determining its behavior and interaction mode */
     type: TLHandleType;
-    /** Whether this handle should snap to other geometry during interactions */
+    /**
+     * @deprecated Use `snapType` instead. Whether this handle should snap to other geometry during interactions.
+     */
     canSnap?: boolean;
+    /** The type of snap to use for this handle */
+    snapType?: 'align' | 'point';
     /** The fractional index used for ordering handles */
     index: IndexKey;
     /** The x-coordinate of the handle in the shape's local coordinate system */

package/dist-cjs/index.js

@@ -177,7 +177,7 @@ var import_TLVerticalAlignStyle = require("./styles/TLVerticalAlignStyle");
 var import_translations = require("./translations/translations");
 (0, import_utils.registerTldrawLibraryVersion)(
   "@tldraw/tlschema",
-  "4.1.0-canary.e23ee15a46bc",
+  "4.1.0-canary.e259b517a450",
   "cjs"
 );
 //# sourceMappingURL=index.js.map

package/dist-cjs/misc/TLHandle.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/misc/TLHandle.ts"],
-  "sourcesContent": ["import { IndexKey } from '@tldraw/utils'\nimport { SetValue } from '../util-types'\n\n/**\n * All available handle types used by shapes in the tldraw editor.\n *\n * Handles are interactive control points on shapes that allow users to\n * modify the shape's geometry. Different handle types serve different purposes:\n *\n * - `vertex`: A control point that defines a vertex of the shape\n * - `virtual`: A handle that exists between vertices for adding new points\n * - `create`: A handle for creating new geometry (like extending a line)\n * - `clone`: A handle for duplicating or cloning shape elements\n *\n * @example\n * ```ts\n * // Check if a handle type is valid\n * if (TL_HANDLE_TYPES.has('vertex')) {\n *   console.log('Valid handle type')\n * }\n *\n * // Get all available handle types\n * const allHandleTypes = Array.from(TL_HANDLE_TYPES)\n * ```\n *\n * @public\n */\nexport const TL_HANDLE_TYPES = new Set(['vertex', 'virtual', 'create', 'clone'] as const)\n\n/**\n * A union type representing all available handle types.\n *\n * Handle types determine how a handle behaves when interacted with and\n * what kind of shape modification it enables.\n *\n * @example\n * ```ts\n * const vertexHandle: TLHandleType = 'vertex'\n * const virtualHandle: TLHandleType = 'virtual'\n * const createHandle: TLHandleType = 'create'\n * const cloneHandle: TLHandleType = 'clone'\n * ```\n *\n * @public\n */\nexport type TLHandleType = SetValue<typeof TL_HANDLE_TYPES>\n\n/**\n * A handle object representing an interactive control point on a shape.\n *\n * Handles allow users to manipulate shape geometry by dragging control points.\n * Each handle has a position, type, and various properties that control its\n * behavior during interactions.\n *\n * @example\n * ```ts\n * // A vertex handle for a line endpoint\n * const lineEndHandle: TLHandle = {\n *   id: 'end',\n *   label: 'End point',\n *   type: 'vertex',\n *   canSnap: true,\n *   index: 'a1',\n *   x: 100,\n *   y: 50\n * }\n *\n * // A virtual handle for adding new points\n * const virtualHandle: TLHandle = {\n *   id: 'virtual-1',\n *   type: 'virtual',\n *   canSnap: false,\n *   index: 'a1V',\n *   x: 75,\n *   y: 25\n * }\n *\n * // A create handle for extending geometry\n * const createHandle: TLHandle = {\n *   id: 'create',\n *   type: 'create',\n *   canSnap: true,\n *   index: 'a2',\n *   x: 200,\n *   y: 100\n * }\n * ```\n *\n * @public\n */\nexport interface TLHandle {\n\t/** A unique identifier for the handle within the shape */\n\tid: string\n\t/** Optional human-readable label for the handle */\n\t// TODO(mime): this needs to be required.\n\tlabel?: string\n\t/** The type of handle, determining its behavior and interaction mode */\n\ttype: TLHandleType\n\t/** Whether this handle should snap to other geometry during interactions */\n\tcanSnap?: boolean\n\t/** The fractional index used for ordering handles */\n\tindex: IndexKey\n\t/** The x-coordinate of the handle in the shape's local coordinate system */\n\tx: number\n\t/** The y-coordinate of the handle in the shape's local coordinate system */\n\ty: number\n}\n"],
+  "sourcesContent": ["import { IndexKey } from '@tldraw/utils'\nimport { SetValue } from '../util-types'\n\n/**\n * All available handle types used by shapes in the tldraw editor.\n *\n * Handles are interactive control points on shapes that allow users to\n * modify the shape's geometry. Different handle types serve different purposes:\n *\n * - `vertex`: A control point that defines a vertex of the shape\n * - `virtual`: A handle that exists between vertices for adding new points\n * - `create`: A handle for creating new geometry (like extending a line)\n * - `clone`: A handle for duplicating or cloning shape elements\n *\n * @example\n * ```ts\n * // Check if a handle type is valid\n * if (TL_HANDLE_TYPES.has('vertex')) {\n *   console.log('Valid handle type')\n * }\n *\n * // Get all available handle types\n * const allHandleTypes = Array.from(TL_HANDLE_TYPES)\n * ```\n *\n * @public\n */\nexport const TL_HANDLE_TYPES = new Set(['vertex', 'virtual', 'create', 'clone'] as const)\n\n/**\n * A union type representing all available handle types.\n *\n * Handle types determine how a handle behaves when interacted with and\n * what kind of shape modification it enables.\n *\n * @example\n * ```ts\n * const vertexHandle: TLHandleType = 'vertex'\n * const virtualHandle: TLHandleType = 'virtual'\n * const createHandle: TLHandleType = 'create'\n * const cloneHandle: TLHandleType = 'clone'\n * ```\n *\n * @public\n */\nexport type TLHandleType = SetValue<typeof TL_HANDLE_TYPES>\n\n/**\n * A handle object representing an interactive control point on a shape.\n *\n * Handles allow users to manipulate shape geometry by dragging control points.\n * Each handle has a position, type, and various properties that control its\n * behavior during interactions.\n *\n * @example\n * ```ts\n * // A vertex handle for a line endpoint\n * const lineEndHandle: TLHandle = {\n *   id: 'end',\n *   label: 'End point',\n *   type: 'vertex',\n *   canSnap: true,\n *   index: 'a1',\n *   x: 100,\n *   y: 50\n * }\n *\n * // A virtual handle for adding new points\n * const virtualHandle: TLHandle = {\n *   id: 'virtual-1',\n *   type: 'virtual',\n *   canSnap: false,\n *   index: 'a1V',\n *   x: 75,\n *   y: 25\n * }\n *\n * // A create handle for extending geometry\n * const createHandle: TLHandle = {\n *   id: 'create',\n *   type: 'create',\n *   canSnap: true,\n *   index: 'a2',\n *   x: 200,\n *   y: 100\n * }\n * ```\n *\n * @public\n */\nexport interface TLHandle {\n\t/** A unique identifier for the handle within the shape */\n\tid: string\n\t/** Optional human-readable label for the handle */\n\t// TODO(mime): this needs to be required.\n\tlabel?: string\n\t/** The type of handle, determining its behavior and interaction mode */\n\ttype: TLHandleType\n\t/**\n\t * @deprecated Use `snapType` instead. Whether this handle should snap to other geometry during interactions.\n\t */\n\tcanSnap?: boolean\n\t/** The type of snap to use for this handle */\n\tsnapType?: 'point' | 'align'\n\t/** The fractional index used for ordering handles */\n\tindex: IndexKey\n\t/** The x-coordinate of the handle in the shape's local coordinate system */\n\tx: number\n\t/** The y-coordinate of the handle in the shape's local coordinate system */\n\ty: number\n}\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA2BO,MAAM,kBAAkB,oBAAI,IAAI,CAAC,UAAU,WAAW,UAAU,OAAO,CAAU;",
   "names": []
 }

package/dist-esm/index.d.mts

@@ -4318,8 +4318,12 @@ export declare interface TLHandle {
     label?: string;
     /** The type of handle, determining its behavior and interaction mode */
     type: TLHandleType;
-    /** Whether this handle should snap to other geometry during interactions */
+    /**
+     * @deprecated Use `snapType` instead. Whether this handle should snap to other geometry during interactions.
+     */
     canSnap?: boolean;
+    /** The type of snap to use for this handle */
+    snapType?: 'align' | 'point';
     /** The fractional index used for ordering handles */
     index: IndexKey;
     /** The x-coordinate of the handle in the shape's local coordinate system */

package/dist-esm/index.mjs

@@ -172,7 +172,7 @@ import {
 } from "./translations/translations.mjs";
 registerTldrawLibraryVersion(
   "@tldraw/tlschema",
-  "4.1.0-canary.e23ee15a46bc",
+  "4.1.0-canary.e259b517a450",
   "esm"
 );
 export {

package/dist-esm/misc/TLHandle.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/misc/TLHandle.ts"],
-  "sourcesContent": ["import { IndexKey } from '@tldraw/utils'\nimport { SetValue } from '../util-types'\n\n/**\n * All available handle types used by shapes in the tldraw editor.\n *\n * Handles are interactive control points on shapes that allow users to\n * modify the shape's geometry. Different handle types serve different purposes:\n *\n * - `vertex`: A control point that defines a vertex of the shape\n * - `virtual`: A handle that exists between vertices for adding new points\n * - `create`: A handle for creating new geometry (like extending a line)\n * - `clone`: A handle for duplicating or cloning shape elements\n *\n * @example\n * ```ts\n * // Check if a handle type is valid\n * if (TL_HANDLE_TYPES.has('vertex')) {\n *   console.log('Valid handle type')\n * }\n *\n * // Get all available handle types\n * const allHandleTypes = Array.from(TL_HANDLE_TYPES)\n * ```\n *\n * @public\n */\nexport const TL_HANDLE_TYPES = new Set(['vertex', 'virtual', 'create', 'clone'] as const)\n\n/**\n * A union type representing all available handle types.\n *\n * Handle types determine how a handle behaves when interacted with and\n * what kind of shape modification it enables.\n *\n * @example\n * ```ts\n * const vertexHandle: TLHandleType = 'vertex'\n * const virtualHandle: TLHandleType = 'virtual'\n * const createHandle: TLHandleType = 'create'\n * const cloneHandle: TLHandleType = 'clone'\n * ```\n *\n * @public\n */\nexport type TLHandleType = SetValue<typeof TL_HANDLE_TYPES>\n\n/**\n * A handle object representing an interactive control point on a shape.\n *\n * Handles allow users to manipulate shape geometry by dragging control points.\n * Each handle has a position, type, and various properties that control its\n * behavior during interactions.\n *\n * @example\n * ```ts\n * // A vertex handle for a line endpoint\n * const lineEndHandle: TLHandle = {\n *   id: 'end',\n *   label: 'End point',\n *   type: 'vertex',\n *   canSnap: true,\n *   index: 'a1',\n *   x: 100,\n *   y: 50\n * }\n *\n * // A virtual handle for adding new points\n * const virtualHandle: TLHandle = {\n *   id: 'virtual-1',\n *   type: 'virtual',\n *   canSnap: false,\n *   index: 'a1V',\n *   x: 75,\n *   y: 25\n * }\n *\n * // A create handle for extending geometry\n * const createHandle: TLHandle = {\n *   id: 'create',\n *   type: 'create',\n *   canSnap: true,\n *   index: 'a2',\n *   x: 200,\n *   y: 100\n * }\n * ```\n *\n * @public\n */\nexport interface TLHandle {\n\t/** A unique identifier for the handle within the shape */\n\tid: string\n\t/** Optional human-readable label for the handle */\n\t// TODO(mime): this needs to be required.\n\tlabel?: string\n\t/** The type of handle, determining its behavior and interaction mode */\n\ttype: TLHandleType\n\t/** Whether this handle should snap to other geometry during interactions */\n\tcanSnap?: boolean\n\t/** The fractional index used for ordering handles */\n\tindex: IndexKey\n\t/** The x-coordinate of the handle in the shape's local coordinate system */\n\tx: number\n\t/** The y-coordinate of the handle in the shape's local coordinate system */\n\ty: number\n}\n"],
+  "sourcesContent": ["import { IndexKey } from '@tldraw/utils'\nimport { SetValue } from '../util-types'\n\n/**\n * All available handle types used by shapes in the tldraw editor.\n *\n * Handles are interactive control points on shapes that allow users to\n * modify the shape's geometry. Different handle types serve different purposes:\n *\n * - `vertex`: A control point that defines a vertex of the shape\n * - `virtual`: A handle that exists between vertices for adding new points\n * - `create`: A handle for creating new geometry (like extending a line)\n * - `clone`: A handle for duplicating or cloning shape elements\n *\n * @example\n * ```ts\n * // Check if a handle type is valid\n * if (TL_HANDLE_TYPES.has('vertex')) {\n *   console.log('Valid handle type')\n * }\n *\n * // Get all available handle types\n * const allHandleTypes = Array.from(TL_HANDLE_TYPES)\n * ```\n *\n * @public\n */\nexport const TL_HANDLE_TYPES = new Set(['vertex', 'virtual', 'create', 'clone'] as const)\n\n/**\n * A union type representing all available handle types.\n *\n * Handle types determine how a handle behaves when interacted with and\n * what kind of shape modification it enables.\n *\n * @example\n * ```ts\n * const vertexHandle: TLHandleType = 'vertex'\n * const virtualHandle: TLHandleType = 'virtual'\n * const createHandle: TLHandleType = 'create'\n * const cloneHandle: TLHandleType = 'clone'\n * ```\n *\n * @public\n */\nexport type TLHandleType = SetValue<typeof TL_HANDLE_TYPES>\n\n/**\n * A handle object representing an interactive control point on a shape.\n *\n * Handles allow users to manipulate shape geometry by dragging control points.\n * Each handle has a position, type, and various properties that control its\n * behavior during interactions.\n *\n * @example\n * ```ts\n * // A vertex handle for a line endpoint\n * const lineEndHandle: TLHandle = {\n *   id: 'end',\n *   label: 'End point',\n *   type: 'vertex',\n *   canSnap: true,\n *   index: 'a1',\n *   x: 100,\n *   y: 50\n * }\n *\n * // A virtual handle for adding new points\n * const virtualHandle: TLHandle = {\n *   id: 'virtual-1',\n *   type: 'virtual',\n *   canSnap: false,\n *   index: 'a1V',\n *   x: 75,\n *   y: 25\n * }\n *\n * // A create handle for extending geometry\n * const createHandle: TLHandle = {\n *   id: 'create',\n *   type: 'create',\n *   canSnap: true,\n *   index: 'a2',\n *   x: 200,\n *   y: 100\n * }\n * ```\n *\n * @public\n */\nexport interface TLHandle {\n\t/** A unique identifier for the handle within the shape */\n\tid: string\n\t/** Optional human-readable label for the handle */\n\t// TODO(mime): this needs to be required.\n\tlabel?: string\n\t/** The type of handle, determining its behavior and interaction mode */\n\ttype: TLHandleType\n\t/**\n\t * @deprecated Use `snapType` instead. Whether this handle should snap to other geometry during interactions.\n\t */\n\tcanSnap?: boolean\n\t/** The type of snap to use for this handle */\n\tsnapType?: 'point' | 'align'\n\t/** The fractional index used for ordering handles */\n\tindex: IndexKey\n\t/** The x-coordinate of the handle in the shape's local coordinate system */\n\tx: number\n\t/** The y-coordinate of the handle in the shape's local coordinate system */\n\ty: number\n}\n"],
   "mappings": "AA2BO,MAAM,kBAAkB,oBAAI,IAAI,CAAC,UAAU,WAAW,UAAU,OAAO,CAAU;",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tldraw/tlschema",
   "description": "tldraw infinite canvas SDK (schema).",
-  "version": "4.1.0-canary.e23ee15a46bc",
+  "version": "4.1.0-canary.e259b517a450",
   "author": {
     "name": "tldraw Inc.",
     "email": "hello@tldraw.com"
@@ -51,10 +51,10 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@tldraw/state": "4.1.0-canary.e23ee15a46bc",
-    "@tldraw/store": "4.1.0-canary.e23ee15a46bc",
-    "@tldraw/utils": "4.1.0-canary.e23ee15a46bc",
-    "@tldraw/validate": "4.1.0-canary.e23ee15a46bc"
+    "@tldraw/state": "4.1.0-canary.e259b517a450",
+    "@tldraw/store": "4.1.0-canary.e259b517a450",
+    "@tldraw/utils": "4.1.0-canary.e259b517a450",
+    "@tldraw/validate": "4.1.0-canary.e259b517a450"
   },
   "peerDependencies": {
     "react": "^18.2.0 || ^19.0.0",

package/src/misc/TLHandle.ts

@@ -96,8 +96,12 @@ export interface TLHandle {
 	label?: string
 	/** The type of handle, determining its behavior and interaction mode */
 	type: TLHandleType
-	/** Whether this handle should snap to other geometry during interactions */
+	/**
+	 * @deprecated Use `snapType` instead. Whether this handle should snap to other geometry during interactions.
+	 */
 	canSnap?: boolean
+	/** The type of snap to use for this handle */
+	snapType?: 'point' | 'align'
 	/** The fractional index used for ordering handles */
 	index: IndexKey
 	/** The x-coordinate of the handle in the shape's local coordinate system */