js-draw 1.21.2 → 1.22.0

package/dist/cjs/toolbar/widgets/PenToolWidget.js

@@ -51,7 +51,7 @@ class PenToolWidget extends BaseToolWidget_1.default {
                 id: 'polyline-pen',
                 factory: PolylineBuilder_1.makePolylineBuilder,
             },
-            ...(additionalPens.filter(pen => !pen.isShapeBuilder)),
+            ...additionalPens.filter((pen) => !pen.isShapeBuilder),
             // Shape pens
             {
                 name: this.localizationTable.arrowPen,
@@ -83,9 +83,9 @@ class PenToolWidget extends BaseToolWidget_1.default {
                 isShapeBuilder: true,
                 factory: CircleBuilder_1.makeOutlinedCircleBuilder,
             },
-            ...(additionalPens.filter(pen => pen.isShapeBuilder)),
+            ...additionalPens.filter((pen) => pen.isShapeBuilder),
         ].filter(filterPens);
-        this.editor.notifier.on(types_1.EditorEventType.ToolUpdated, toolEvt => {
+        this.editor.notifier.on(types_1.EditorEventType.ToolUpdated, (toolEvt) => {
             if (toolEvt.kind !== types_1.EditorEventType.ToolUpdated) {
                 throw new Error('Invalid event type!');
             }
@@ -128,7 +128,10 @@ class PenToolWidget extends BaseToolWidget_1.default {
             style.factory = record.factory;
         }
         const strokeFactory = record?.factory;
-        if (!strokeFactory || strokeFactory === FreehandLineBuilder_1.makeFreehandLineBuilder || strokeFactory === PressureSensitiveFreehandLineBuilder_1.makePressureSensitiveFreehandLineBuilder || strokeFactory === PolylineBuilder_1.makePolylineBuilder) {
+        if (!strokeFactory ||
+            strokeFactory === FreehandLineBuilder_1.makeFreehandLineBuilder ||
+            strokeFactory === PressureSensitiveFreehandLineBuilder_1.makePressureSensitiveFreehandLineBuilder ||
+            strokeFactory === PolylineBuilder_1.makePolylineBuilder) {
             return this.editor.icons.makePenIcon(style);
         }
         else {
@@ -148,8 +151,10 @@ class PenToolWidget extends BaseToolWidget_1.default {
                 isShapeBuilder: penType.isShapeBuilder ?? false,
             };
         });
-        const penSelector = (0, makeGridSelector_1.default)(this.localizationTable.selectPenType, this.getCurrentPenTypeIdx(), allChoices.filter(choice => !choice.isShapeBuilder));
-        const shapeSelector = (0, makeGridSelector_1.default)(this.localizationTable.selectShape, this.getCurrentPenTypeIdx(), allChoices.filter(choice => choice.isShapeBuilder));
+        const penItems = allChoices.filter((choice) => !choice.isShapeBuilder);
+        const penSelector = (0, makeGridSelector_1.default)(this.localizationTable.selectPenType, this.getCurrentPenTypeIdx(), penItems);
+        const shapeItems = allChoices.filter((choice) => choice.isShapeBuilder);
+        const shapeSelector = (0, makeGridSelector_1.default)(this.localizationTable.selectShape, this.getCurrentPenTypeIdx(), shapeItems);
         const onSelectorUpdate = (newPenTypeIndex) => {
             this.tool.setStrokeFactory(this.penTypes[newPenTypeIndex].factory);
         };
@@ -166,8 +171,12 @@ class PenToolWidget extends BaseToolWidget_1.default {
                 shapeSelector.updateIcons();
             },
             addTo: (parent) => {
-                penSelector.addTo(parent);
-                shapeSelector.addTo(parent);
+                if (penItems.length) {
+                    penSelector.addTo(parent);
+                }
+                if (shapeItems.length) {
+                    shapeSelector.addTo(parent);
+                }
             },
         };
     }
@@ -205,11 +214,11 @@ class PenToolWidget extends BaseToolWidget_1.default {
             return result;
         };
         const stabilizationOption = addToggleButton(this.localizationTable.inputStabilization, this.editor.icons.makeStrokeSmoothingIcon());
-        stabilizationOption.setOnInputListener(enabled => {
+        stabilizationOption.setOnInputListener((enabled) => {
             this.tool.setHasStabilization(enabled);
         });
         const autocorrectOption = addToggleButton(this.localizationTable.strokeAutocorrect, this.editor.icons.makeShapeAutocorrectIcon());
-        autocorrectOption.setOnInputListener(enabled => {
+        autocorrectOption.setOnInputListener((enabled) => {
             this.tool.setStrokeAutocorrectEnabled(enabled);
         });
         // Help text
@@ -232,12 +241,12 @@ class PenToolWidget extends BaseToolWidget_1.default {
         const container = document.createElement('div');
         container.classList.add(`${constants_1.toolbarCSSPrefix}spacedList`, `${constants_1.toolbarCSSPrefix}nonbutton-controls-main-list`);
         // Thickness: Value of the input is squared to allow for finer control/larger values.
-        const { container: thicknessRow, setValue: setThickness } = (0, makeThicknessSlider_1.default)(this.editor, thickness => {
+        const { container: thicknessRow, setValue: setThickness } = (0, makeThicknessSlider_1.default)(this.editor, (thickness) => {
             this.tool.setThickness(thickness);
         });
         const colorRow = document.createElement('div');
         const colorLabel = document.createElement('label');
-        const colorInputControl = (0, makeColorInput_1.default)(this.editor, color => {
+        const colorInputControl = (0, makeColorInput_1.default)(this.editor, (color) => {
             this.tool.setColor(color);
         });
         const { input: colorInput, container: colorInputContainer } = colorInputControl;
@@ -306,7 +315,7 @@ class PenToolWidget extends BaseToolWidget_1.default {
     deserializeFrom(state) {
         super.deserializeFrom(state);
         const verifyPropertyType = (propertyName, expectedType) => {
-            const actualType = typeof (state[propertyName]);
+            const actualType = typeof state[propertyName];
             if (actualType !== expectedType) {
                 throw new Error(`Deserializing property ${propertyName}: Invalid type. Expected ${expectedType},` +
                     ` was ${actualType}.`);

package/dist/cjs/toolbar/widgets/SelectionToolWidget.js

@@ -18,7 +18,7 @@ const makeFormatMenu = (editor, selectionTool, localizationTable) => {
     container.classList.add('selection-format-menu', `${constants_1.toolbarCSSPrefix}spacedList`, `${constants_1.toolbarCSSPrefix}indentedList`);
     const colorRow = document.createElement('div');
     const colorLabel = document.createElement('label');
-    const colorInputControl = (0, makeColorInput_1.default)(editor, color => {
+    const colorInputControl = (0, makeColorInput_1.default)(editor, (color) => {
         const selection = selectionTool.getSelection();
         if (selection) {
             const updateStyleCommands = [];
@@ -99,7 +99,7 @@ class SelectionToolWidget extends BaseToolWidget_1.default {
         };
         updateDisabled(true);
         // Enable/disable actions based on whether items are selected
-        this.editor.notifier.on(types_1.EditorEventType.ToolUpdated, toolEvt => {
+        this.editor.notifier.on(types_1.EditorEventType.ToolUpdated, (toolEvt) => {
             if (toolEvt.kind !== types_1.EditorEventType.ToolUpdated) {
                 throw new Error('Invalid event type!');
             }

package/dist/cjs/toolbar/widgets/TextToolWidget.js

@@ -13,7 +13,7 @@ class TextToolWidget extends BaseToolWidget_1.default {
         super(editor, tool, 'text-tool-widget', localization);
         this.tool = tool;
         this.updateDropdownInputs = null;
-        editor.notifier.on(types_1.EditorEventType.ToolUpdated, evt => {
+        editor.notifier.on(types_1.EditorEventType.ToolUpdated, (evt) => {
             if (evt.kind === types_1.EditorEventType.ToolUpdated && evt.tool === tool) {
                 this.updateIcon();
                 this.updateDropdownInputs?.();
@@ -37,7 +37,7 @@ class TextToolWidget extends BaseToolWidget_1.default {
         const fontLabel = document.createElement('label');
         const sizeInput = document.createElement('input');
         const sizeLabel = document.createElement('label');
-        const { input: colorInput, container: colorInputContainer, setValue: setColorInputValue } = (0, makeColorInput_1.default)(this.editor, color => {
+        const { input: colorInput, container: colorInputContainer, setValue: setColorInputValue, } = (0, makeColorInput_1.default)(this.editor, (color) => {
             this.tool.setColor(color);
         });
         const colorLabel = document.createElement('label');
@@ -105,13 +105,13 @@ class TextToolWidget extends BaseToolWidget_1.default {
         };
     }
     deserializeFrom(state) {
-        if (state.fontFamily && typeof (state.fontFamily) === 'string') {
+        if (state.fontFamily && typeof state.fontFamily === 'string') {
             this.tool.setFontFamily(state.fontFamily);
         }
-        if (state.color && typeof (state.color) === 'string') {
+        if (state.color && typeof state.color === 'string') {
             this.tool.setColor(math_1.Color4.fromHex(state.color));
         }
-        if (state.textSize && typeof (state.textSize) === 'number') {
+        if (state.textSize && typeof state.textSize === 'number') {
             this.tool.setFontSize(state.textSize);
         }
         super.deserializeFrom(state);

package/dist/cjs/toolbar/widgets/components/makeFileInput.js

@@ -47,7 +47,7 @@ const makeFileInput = (labelText, context, { accepts = '*', allowMultiSelect = f
             icon.style.display = 'none';
         }
         else if (files.length > 0) {
-            const fileNames = files.map(file => file.name);
+            const fileNames = files.map((file) => file.name);
             const maxNames = 5;
             if (fileNames.length <= maxNames) {
                 descriptionText.textContent = fileNames.join('\n');
@@ -89,15 +89,15 @@ const makeFileInput = (labelText, context, { accepts = '*', allowMultiSelect = f
     };
     const addFileEventListeners = () => {
         // Support dropping files
-        label.addEventListener('dragover', event => {
+        label.addEventListener('dragover', (event) => {
             event.preventDefault();
             label.classList.add('drag-target');
         });
-        label.addEventListener('dragenter', event => {
+        label.addEventListener('dragenter', (event) => {
             event.preventDefault();
             label.classList.add('drag-target');
         });
-        label.addEventListener('dragleave', event => {
+        label.addEventListener('dragleave', (event) => {
             event.preventDefault();
             // Ensure the event wasn't targeting a child.
             // See https://stackoverflow.com/a/54271161 and
@@ -108,7 +108,7 @@ const makeFileInput = (labelText, context, { accepts = '*', allowMultiSelect = f
             }
         });
         // See https://developer.mozilla.org/en-US/docs/Web/API/HTML_Drag_and_Drop_API/File_drag_and_drop#process_the_drop
-        label.addEventListener('drop', event => {
+        label.addEventListener('drop', (event) => {
             event.preventDefault();
             label.classList.remove('drag-target');
             const fileList = [];
@@ -137,7 +137,7 @@ const makeFileInput = (labelText, context, { accepts = '*', allowMultiSelect = f
                 const data = await customPickerAction({
                     setOnCancelCallback: (onCancel) => {
                         if (!loading) {
-                            throw new Error('Task already completed. Can\'t register cancel handler.');
+                            throw new Error("Task already completed. Can't register cancel handler.");
                         }
                         cancelLoading = () => {
                             cancelLoading = null;
@@ -159,7 +159,7 @@ const makeFileInput = (labelText, context, { accepts = '*', allowMultiSelect = f
         };
         input.onclick = promptForFiles;
     }
-    selectedFiles.onUpdate(files => {
+    selectedFiles.onUpdate((files) => {
         if (files.length === 0 && input.files && input.files.length > 0) {
             input.value = '';
         }

package/dist/cjs/toolbar/widgets/components/makeGridSelector.js

@@ -26,7 +26,7 @@ labelText, defaultId, choices) => {
     menuContainer.id = `${constants_1.toolbarCSSPrefix}-grid-select-id-${idCounter++}`;
     (0, stopPropagationOfScrollingWheelEvents_1.default)(menuContainer);
     const label = document.createElement('label');
-    label.innerText = labelText;
+    label.textContent = labelText;
     label.htmlFor = menuContainer.id;
     outerContainer.appendChild(label);
     // All buttons in a radiogroup need the same name attribute.
@@ -88,7 +88,7 @@ labelText, defaultId, choices) => {
         // Prevent the right-click menu from being shown on long-press
         // (important for some toolbars that use long-press gestures to
         // show grid selector labels).
-        buttonContainer.oncontextmenu = event => {
+        buttonContainer.oncontextmenu = (event) => {
             event.preventDefault();
         };
         buttonContainer.replaceChildren(button, labelContainer);
@@ -107,7 +107,7 @@ labelText, defaultId, choices) => {
             choiceRecord: record,
             setChecked,
             updateIcon,
-            updateButtonRadiogroupName
+            updateButtonRadiogroupName,
         };
     };
     const buttons = [];
@@ -118,7 +118,7 @@ labelText, defaultId, choices) => {
     // However, it is still possible that selectedValue does not correspond
     // to a choice in `choices`. This is acceptable.
     outerContainer.appendChild(menuContainer);
-    selectedValue.onUpdateAndNow(choiceId => {
+    selectedValue.onUpdateAndNow((choiceId) => {
         for (let i = 0; i < buttons.length; i++) {
             buttons[i].setChecked(buttons[i].choiceRecord.id === choiceId);
         }
@@ -134,7 +134,7 @@ labelText, defaultId, choices) => {
             }
         },
         updateIcons: () => {
-            buttons.forEach(button => button.updateIcon());
+            buttons.forEach((button) => button.updateIcon());
         },
         getRootElement() {
             return outerContainer;

package/dist/cjs/toolbar/widgets/components/makeSnappedList.js

@@ -22,7 +22,10 @@ const makeSnappedList = (itemsValue) => {
         // TODO: Does it make sense for the page marker list to be focusable?
         markerContainer.setAttribute('tabindex', '-1');
         const markers = [];
-        const pairedItems = ReactiveValue_1.ReactiveValue.union([visibleIndex, itemsValue]);
+        const pairedItems = ReactiveValue_1.ReactiveValue.union([
+            visibleIndex,
+            itemsValue,
+        ]);
         pairedItems.onUpdateAndNow(([currentVisibleIndex, items]) => {
             let addedOrRemovedMarkers = false;
             // Items may have been removed from the list of pages. Make the markers reflect that.
@@ -56,7 +59,8 @@ const makeSnappedList = (itemsValue) => {
                 }
                 const markerIndex = i;
                 marker.onclick = () => {
-                    wrappedItems.get()[markerIndex]?.element?.scrollIntoView({ block: 'nearest', behavior: 'smooth' });
+                    wrappedItems
+                        .get()[markerIndex]?.element?.scrollIntoView({ block: 'nearest', behavior: 'smooth' });
                 };
             }
             // Only call .replaceChildren when necessary -- doing so on every change would
@@ -104,7 +108,7 @@ const makeSnappedList = (itemsValue) => {
             observer = null;
         }
     };
-    const wrappedItems = ReactiveValue_1.ReactiveValue.map(itemsValue, items => {
+    const wrappedItems = ReactiveValue_1.ReactiveValue.map(itemsValue, (items) => {
         return items.map((item, index) => {
             const wrapper = document.createElement('div');
             if (item.element.parentElement)
@@ -119,7 +123,7 @@ const makeSnappedList = (itemsValue) => {
         });
     });
     const lastItems = [];
-    wrappedItems.onUpdateAndNow(items => {
+    wrappedItems.onUpdateAndNow((items) => {
         visibleIndex.set(-1);
         for (const item of lastItems) {
             observer?.unobserve(item.element);
@@ -149,7 +153,7 @@ const makeSnappedList = (itemsValue) => {
             }
         }
     });
-    const visibleItem = ReactiveValue_1.ReactiveValue.map(visibleIndex, index => {
+    const visibleItem = ReactiveValue_1.ReactiveValue.map(visibleIndex, (index) => {
         const values = itemsValue.get();
         if (0 <= index && index < values.length) {
             return values[index].data;

package/dist/cjs/toolbar/widgets/keybindings.js

@@ -9,10 +9,10 @@ const KeyboardShortcutManager_1 = __importDefault(require("../../shortcuts/Keybo
 exports.resizeImageToSelectionKeyboardShortcut = 'jsdraw.toolbar.SelectionTool.resizeImageToSelection';
 KeyboardShortcutManager_1.default.registerDefaultKeyboardShortcut(exports.resizeImageToSelectionKeyboardShortcut, ['ctrlOrMeta+r'], 'Resize image to selection');
 // Pen tool
-exports.selectStrokeTypeKeyboardShortcutIds = [1, 2, 3, 4, 5, 6, 7, 8, 9].map(id => `jsdraw.toolbar.PenTool.select-pen-${id}`);
+exports.selectStrokeTypeKeyboardShortcutIds = [1, 2, 3, 4, 5, 6, 7, 8, 9].map((id) => `jsdraw.toolbar.PenTool.select-pen-${id}`);
 for (let i = 0; i < exports.selectStrokeTypeKeyboardShortcutIds.length; i++) {
     const id = exports.selectStrokeTypeKeyboardShortcutIds[i];
-    KeyboardShortcutManager_1.default.registerDefaultKeyboardShortcut(id, [`CtrlOrMeta+Digit${(i + 1)}`], 'Select pen style ' + (i + 1));
+    KeyboardShortcutManager_1.default.registerDefaultKeyboardShortcut(id, [`CtrlOrMeta+Digit${i + 1}`], 'Select pen style ' + (i + 1));
 }
 // Save
 exports.saveKeyboardShortcut = 'jsdraw.toolbar.SaveActionWidget.save';

package/dist/cjs/toolbar/widgets/layout/DropdownLayoutManager.js

@@ -49,7 +49,7 @@ class Dropdown {
         }
         // Shift the dropdown if it's off the screen, but only if doing so moves it on to the screen
         // (prevents dropdowns from going almost completely offscreen on small screens).
-        if (dropdownBBox.bottom > screenHeight && (dropdownBBox.top - dropdownBBox.height > 0)) {
+        if (dropdownBBox.bottom > screenHeight && dropdownBBox.top - dropdownBBox.height > 0) {
             const targetElem = this.parent.target;
             translateY = `calc(-${targetElem.clientHeight}px - 100%)`;
         }
@@ -136,7 +136,7 @@ class DropdownLayoutManager {
                 return;
             announceForAccessibility(this.localization.dropdownShown(dropdown.parent.getTitle()));
             // Share the event with other connected notifiers
-            this.connectedNotifiers.forEach(notifier => {
+            this.connectedNotifiers.forEach((notifier) => {
                 notifier.dispatch(types_1.EditorEventType.ToolbarDropdownShown, {
                     kind: types_1.EditorEventType.ToolbarDropdownShown,
                     fromToplevelDropdown,
@@ -173,7 +173,7 @@ class DropdownLayoutManager {
     refreshListeners() {
         const clearListeners = () => {
             // Remove all listeners & resources that won't be garbage collected.
-            this.listeners.forEach(l => l.remove());
+            this.listeners.forEach((l) => l.remove());
             this.listeners = [];
         };
         if (this.dropdowns.size === 0) {
@@ -181,11 +181,11 @@ class DropdownLayoutManager {
         }
         else if (this.listeners.length !== this.connectedNotifiers.length) {
             clearListeners();
-            this.listeners = this.connectedNotifiers.map(notifier => {
+            this.listeners = this.connectedNotifiers.map((notifier) => {
                 return notifier.on(types_1.EditorEventType.ToolbarDropdownShown, (evt) => {
-                    if (evt.kind !== types_1.EditorEventType.ToolbarDropdownShown
+                    if (evt.kind !== types_1.EditorEventType.ToolbarDropdownShown ||
                         // Don't forward to ourselves events that we originally triggered.
-                        || evt.layoutManager === this) {
+                        evt.layoutManager === this) {
                         return;
                     }
                     this.notifier.dispatch(DropdownEventType.DropdownShown, {

package/dist/cjs/tools/BaseTool.d.ts

@@ -0,0 +1,61 @@
+import { EditorNotifier } from '../types';
+import { WheelEvt, PointerEvt, KeyPressEvent, KeyUpEvent, PasteEvent, CopyEvent, InputEvt, GestureCancelEvt, PointerDownEvt, PointerMoveEvt, PointerUpEvt, ContextMenuEvt } from '../inputEvents';
+import ToolEnabledGroup from './ToolEnabledGroup';
+import InputMapper, { InputEventListener } from './InputFilter/InputMapper';
+import { ReactiveValue } from '../util/ReactiveValue';
+export default abstract class BaseTool implements InputEventListener {
+    #private;
+    private notifier;
+    readonly description: string;
+    protected constructor(notifier: EditorNotifier, description: string);
+    /** Override this to allow this tool to be enabled in a read-only editor */
+    canReceiveInputInReadOnlyEditor(): boolean;
+    setInputMapper(mapper: InputMapper | null): void;
+    getInputMapper(): InputMapper | null;
+    private dispatchEventToCallback;
+    onEvent(event: InputEvt): boolean;
+    /**
+     * Returns true iff the tool handled the event and thus should receive additional
+     * events.
+     */
+    onPointerDown(_event: PointerDownEvt): boolean;
+    onPointerMove(_event: PointerMoveEvt): void;
+    /**
+     * Returns true iff there are additional pointers down and the tool should
+     * remain active to handle the additional events.
+     *
+     * For most purposes, this should return `false` or nothing.
+     */
+    onPointerUp(_event: PointerUpEvt): boolean | void;
+    onGestureCancel(_event: GestureCancelEvt): void;
+    onWheel(_event: WheelEvt): boolean;
+    onCopy(_event: CopyEvent): boolean;
+    onPaste(_event: PasteEvent): boolean;
+    onKeyPress(_event: KeyPressEvent): boolean;
+    onKeyUp(_event: KeyUpEvent): boolean;
+    onContextMenu(_event: ContextMenuEvt): boolean;
+    /**
+     * Return true if, while this tool is active, `_event` can be delivered to
+     * another tool that is higher priority than this.
+     * @internal May be renamed
+     */
+    eventCanBeDeliveredToNonActiveTool(_event: PointerEvt): boolean;
+    setEnabled(enabled: boolean): void;
+    isEnabled(): boolean;
+    /**
+     * Returns a {@link ReactiveValue} that updates based on whether this tool is
+     * enabled.
+     *
+     * @example
+     * ```ts
+     * const tool = new SomeTool();
+     *
+     * // Watch for changes in enabled status
+     * tool.enabledValue().onUpdate(enabled => doSomething(enabled));
+     * ```
+     */
+    enabledValue(): ReactiveValue<boolean>;
+    setToolGroup(group: ToolEnabledGroup): void;
+    getToolGroup(): ToolEnabledGroup | null;
+    onDestroy(): void;
+}

package/dist/cjs/tools/BaseTool.js

@@ -0,0 +1,181 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _BaseTool_enabled, _BaseTool_group, _BaseTool_inputMapper, _BaseTool_readOnlyEditorChangeListener;
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("../types");
+const inputEvents_1 = require("../inputEvents");
+const ReactiveValue_1 = require("../util/ReactiveValue");
+class BaseTool {
+    constructor(notifier, description) {
+        this.notifier = notifier;
+        this.description = description;
+        _BaseTool_enabled.set(this, void 0);
+        _BaseTool_group.set(this, null);
+        _BaseTool_inputMapper.set(this, null);
+        _BaseTool_readOnlyEditorChangeListener.set(this, null);
+        __classPrivateFieldSet(this, _BaseTool_enabled, ReactiveValue_1.ReactiveValue.fromInitialValue(true), "f");
+        __classPrivateFieldGet(this, _BaseTool_enabled, "f").onUpdate((enabled) => {
+            // Ensure that at most one tool in the group is enabled.
+            if (enabled) {
+                __classPrivateFieldGet(this, _BaseTool_group, "f")?.notifyEnabled(this);
+                this.notifier.dispatch(types_1.EditorEventType.ToolEnabled, {
+                    kind: types_1.EditorEventType.ToolEnabled,
+                    tool: this,
+                });
+            }
+            else {
+                this.notifier.dispatch(types_1.EditorEventType.ToolDisabled, {
+                    kind: types_1.EditorEventType.ToolDisabled,
+                    tool: this,
+                });
+            }
+        });
+    }
+    /** Override this to allow this tool to be enabled in a read-only editor */
+    canReceiveInputInReadOnlyEditor() {
+        return false;
+    }
+    setInputMapper(mapper) {
+        __classPrivateFieldSet(this, _BaseTool_inputMapper, mapper, "f");
+        if (mapper) {
+            mapper.setEmitListener((event) => this.dispatchEventToCallback(event));
+        }
+    }
+    getInputMapper() {
+        return __classPrivateFieldGet(this, _BaseTool_inputMapper, "f");
+    }
+    dispatchEventToCallback(event) {
+        let exhaustivenessCheck;
+        switch (event.kind) {
+            case inputEvents_1.InputEvtType.PointerDownEvt:
+                return this.onPointerDown(event);
+            case inputEvents_1.InputEvtType.PointerMoveEvt:
+                this.onPointerMove(event);
+                break;
+            case inputEvents_1.InputEvtType.PointerUpEvt:
+                return this.onPointerUp(event) ?? false;
+            case inputEvents_1.InputEvtType.GestureCancelEvt:
+                this.onGestureCancel(event);
+                break;
+            case inputEvents_1.InputEvtType.WheelEvt:
+                return this.onWheel(event);
+            case inputEvents_1.InputEvtType.KeyPressEvent:
+                return this.onKeyPress(event);
+            case inputEvents_1.InputEvtType.KeyUpEvent:
+                return this.onKeyUp(event);
+            case inputEvents_1.InputEvtType.CopyEvent:
+                return this.onCopy(event);
+            case inputEvents_1.InputEvtType.PasteEvent:
+                return this.onPaste(event);
+            case inputEvents_1.InputEvtType.ContextMenu:
+                return this.onContextMenu(event);
+            default:
+                exhaustivenessCheck = event;
+                return exhaustivenessCheck;
+        }
+        return true;
+    }
+    // @internal
+    onEvent(event) {
+        if (__classPrivateFieldGet(this, _BaseTool_inputMapper, "f")) {
+            return __classPrivateFieldGet(this, _BaseTool_inputMapper, "f").onEvent(event);
+        }
+        return this.dispatchEventToCallback(event);
+    }
+    /**
+     * Returns true iff the tool handled the event and thus should receive additional
+     * events.
+     */
+    onPointerDown(_event) {
+        return false;
+    }
+    onPointerMove(_event) { }
+    /**
+     * Returns true iff there are additional pointers down and the tool should
+     * remain active to handle the additional events.
+     *
+     * For most purposes, this should return `false` or nothing.
+     */
+    onPointerUp(_event) { }
+    onGestureCancel(_event) { }
+    onWheel(_event) {
+        return false;
+    }
+    onCopy(_event) {
+        return false;
+    }
+    onPaste(_event) {
+        return false;
+    }
+    onKeyPress(_event) {
+        return false;
+    }
+    onKeyUp(_event) {
+        return false;
+    }
+    onContextMenu(_event) {
+        return false;
+    }
+    /**
+     * Return true if, while this tool is active, `_event` can be delivered to
+     * another tool that is higher priority than this.
+     * @internal May be renamed
+     */
+    eventCanBeDeliveredToNonActiveTool(_event) {
+        return true;
+    }
+    setEnabled(enabled) {
+        __classPrivateFieldGet(this, _BaseTool_enabled, "f").set(enabled);
+    }
+    isEnabled() {
+        return __classPrivateFieldGet(this, _BaseTool_enabled, "f").get();
+    }
+    /**
+     * Returns a {@link ReactiveValue} that updates based on whether this tool is
+     * enabled.
+     *
+     * @example
+     * ```ts
+     * const tool = new SomeTool();
+     *
+     * // Watch for changes in enabled status
+     * tool.enabledValue().onUpdate(enabled => doSomething(enabled));
+     * ```
+     */
+    enabledValue() {
+        return __classPrivateFieldGet(this, _BaseTool_enabled, "f");
+    }
+    // Connect this tool to a set of other tools, ensuring that at most one
+    // of the tools in the group is enabled.
+    setToolGroup(group) {
+        if (this.isEnabled()) {
+            group.notifyEnabled(this);
+        }
+        __classPrivateFieldSet(this, _BaseTool_group, group, "f");
+    }
+    getToolGroup() {
+        if (__classPrivateFieldGet(this, _BaseTool_group, "f")) {
+            return __classPrivateFieldGet(this, _BaseTool_group, "f");
+        }
+        return null;
+    }
+    // Called when the tool is removed/when the editor is destroyed.
+    // Subclasses that override this method **must call super.onDestroy()**.
+    onDestroy() {
+        __classPrivateFieldGet(this, _BaseTool_readOnlyEditorChangeListener, "f")?.remove();
+        __classPrivateFieldSet(this, _BaseTool_readOnlyEditorChangeListener, null, "f");
+        __classPrivateFieldSet(this, _BaseTool_group, null, "f");
+    }
+}
+_BaseTool_enabled = new WeakMap(), _BaseTool_group = new WeakMap(), _BaseTool_inputMapper = new WeakMap(), _BaseTool_readOnlyEditorChangeListener = new WeakMap();
+exports.default = BaseTool;

package/dist/cjs/tools/Eraser.d.ts

@@ -0,0 +1,60 @@
+import { GestureCancelEvt, KeyPressEvent, PointerEvt } from '../inputEvents';
+import BaseTool from './BaseTool';
+import Editor from '../Editor';
+import { MutableReactiveValue } from '../util/ReactiveValue';
+export declare enum EraserMode {
+    PartialStroke = "partial-stroke",
+    FullStroke = "full-stroke"
+}
+export interface InitialEraserOptions {
+    thickness?: number;
+    mode?: EraserMode;
+}
+/**
+ * A tool that allows a user to erase parts of an image.
+ */
+export default class Eraser extends BaseTool {
+    private editor;
+    private lastPoint;
+    private isFirstEraseEvt;
+    private thickness;
+    private thicknessValue;
+    private modeValue;
+    private toRemove;
+    private toAdd;
+    private eraseCommands;
+    private addCommands;
+    constructor(editor: Editor, description: string, options?: InitialEraserOptions);
+    /**
+     * @returns a tool that briefly enables the eraser when a physical eraser is used.
+     * This tool should be added to the tool list after the primary tools.
+     */
+    makeEraserSwitcherTool(): BaseTool;
+    private clearPreview;
+    private getSizeOnCanvas;
+    private drawPreviewAt;
+    /**
+     * @returns the eraser rectangle in canvas coordinates.
+     *
+     * For now, all erasers are rectangles or points.
+     */
+    private getEraserRect;
+    /** Erases in a line from the last point to the current. */
+    private eraseTo;
+    onPointerDown(event: PointerEvt): boolean;
+    onPointerMove(event: PointerEvt): void;
+    onPointerUp(event: PointerEvt): void;
+    onGestureCancel(_event: GestureCancelEvt): void;
+    onKeyPress(event: KeyPressEvent): boolean;
+    /** Returns the side-length of the tip of this eraser. */
+    getThickness(): number;
+    /** Sets the side-length of this' tip. */
+    setThickness(thickness: number): void;
+    /**
+     * Returns a {@link MutableReactiveValue} that can be used to watch
+     * this tool's thickness.
+     */
+    getThicknessValue(): MutableReactiveValue<number>;
+    /** @returns An object that allows switching between a full stroke and a partial stroke eraser. */
+    getModeValue(): MutableReactiveValue<EraserMode>;
+}