@weasel-js/path-tools 0.0.0-stage → 1.10.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 orochi235
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,48 @@
-# Temporary Holding Version
+# @weasel-js/path-tools
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Path-editing tools for a weasel canvas, each family a preset an app turns on
+beside core's own.
+
+Part of [weasel](https://github.com/orochi235/weasel), a domain-agnostic 2D
+scene-graph canvas kit for React. See the
+[API reference](https://orochi235.github.io/weasel/#pkg/path-tools).
+
+```sh
+npm install @weasel-js/path-tools
+```
+
+Core keeps basic path editing: anchors and handles, bending a segment, Join,
+Average, Cut at crossings, Simplify, and Offset. This package adds the rest,
+on core's public surface:
+
+```tsx
+import { SceneCanvas } from '@weasel-js/core';
+import { pathTools } from '@weasel-js/path-tools';
+
+<SceneCanvas scene={scene} features={['draw', pathTools]} />;
+```
+
+`pathTools` turns every family on. Each is also a preset of its own, and an app
+that imports only some never loads the others:
+
+| Preset | What it adds |
+|---|---|
+| `simplifyBrushPreset` | The Simplify brush, a path-edit tool that refits the curve it passes over |
+| `handleLocksPreset` | The `handleLock.angle` and `handleLock.length` toggles |
+| `bridgePreset` | Bridge: join open ends with a curve along each end's heading, on paths or on two anchors |
+| `trimPreset`, `extendPreset`, `smudgePreset` | The actions `useTrimTool`, `useExtendTool`, and `useSmudgeBrushTool` bind |
+| `harmonizePreset` | Harmonize curvature |
+| `curvatureCombPreset` | The curvature comb over the open path, under chrome id `path-edit.comb` |
+| `balancePreset` | Balance handles and Equalize, from grips under chrome id `path-edit.balance` |
+| `constraintsPreset` | Path constraints: the actions, their marks, and every edit finished so they hold |
+| `pathEffectsPreset` | Blend, Bend along, and Repeat along, and the actions that edit and expand them |
+| `warpPreset` | Expand and configure a held warp; `useDistortTool`, `useEnvelopeTool`, and `usePuppetTool` bring their own drags |
+
+The comb, balance lines, and constraint marks are off until chrome-caps shows
+them, and `createCurvatureCombPreset`, `createBalancePreset`, and
+`createConstraintsPreset` take their look. They reach path edit through core's
+`PathEditExtension`: marks drawn on the open path, parts of it to press, marks
+a click selects and Delete removes, and what an edit keeps true.
+
+The tools are hooks, mounted with `<SceneCanvas tools>` as core's are; each
+binds an action its family's preset registers, so turn on both.