@toolpath/plan 0.1.0 → 0.2.1

package/README.md

@@ -120,7 +120,7 @@ const press = (action: DraftAction) => {
 | `addSetup`            | A setup facing a direction nothing faces yet                                                      |
 | `setProcess`          | Hold a setup 3 axis, 3+1 or 3+2                                                                   |
 | `setToolOrientation`  | A folder in an indexed setup tilted to a direction of its own, or not                             |
-| `pinInto`             | A click on the part in an open folder: the feature pinned there, or taken out if it is            |
+| `pinInto`             | In an open folder: a left click pins the feature there, a right click takes out one pinned there  |
 | `pinFrom`             | The feature pinned in the folder facing its direction, or a new setup; let go if pinned that way  |
 | `moveFeature`         | A feature's row dropped on a folder: pinned there                                                 |
 | `unpin`               | The feature let go: Toolpath decides where it is machined                                         |
@@ -134,7 +134,9 @@ Each kind makes the plan Toolpath's own app makes for the same click; the packag
 to the app's own helper. A pin,
 of any kind, does what pinning does there: the person's pins whose every face it covers are let go,
 and its own faces are no longer ignored. Pinning a feature where it is pinned already lets it go, as
-a second click does.
+a right click does. A left click on a feature in the open folder already sends nothing: it stays,
+and a pick among its readings (`choosePinReading`, `target: 'add'`) pins another beside it. With
+Ignore open, `ignoreClick` says what a click does: a left click ignores, a right click lets go.
 
 `facts` say what the action did beyond the draft, for the status line: the pins a pin `replaced`,
 the faces it `unignored`, the pins an ignore `unpinned`, whether a pin `added` a setup, whether it

package/dist/index.d.ts

@@ -601,27 +601,29 @@ declare const regionLabel: (regions: ReadonlyArray<number>) => string;
 declare const takeBackIgnore: (plan: Constraints, saved: Constraints, regions: ReadonlyArray<number>, context: Pick<PlanRules, "kernel">) => Constraints;
 /** What a click on the part does while ignoring (`ignoreClick`). */
 type IgnoreClick = 
-/** The region was ignored: the ignored regions among those taken are let go. */
+/** A right click: the ignored regions among those taken are let go. */
 {
     kind: 'unignore';
     regions: Array<number>;
 }
-/** What the click takes is ignored. */
+/** A left click: what the click takes is ignored. */
  | {
     kind: 'ignore';
     regions: Array<number>;
 };
 /**
- * What a click on region `region`, taking `regions` (`ignoreSelection`), does while ignoring:
- * ignored, the ignored regions among those taken are let go; otherwise they are ignored.
+ * What a click taking `regions` (`ignoreSelection`) does while ignoring: a left click ignores
+ * them, a right click (`remove`) lets go of those ignored. Null where it has nothing to do: a left
+ * click on regions every one ignored, a right click on none.
  */
-declare const ignoreClick: ({ region, ignored, regions, }: {
-    region: number;
+declare const ignoreClick: ({ ignored, regions, remove, }: {
     /** The regions ignored now. */
     ignored: ReadonlySet<number>;
     /** The regions the click takes: the CAD face clicked, or a feature's faces. */
     regions: ReadonlyArray<number>;
-}) => IgnoreClick;
+    /** A right click: it takes out, never adds. */
+    remove: boolean;
+}) => IgnoreClick | null;
 
 /**
  * One edit to a plan's constraints: its setups, folders, pins and ignored faces. Every id an action
@@ -726,17 +728,16 @@ type DraftAction =
 }
 /**
  * A pick among the features a click in a folder read (`chooseReading`): `reading` meant instead of
- * `tag`, which the click pinned (`target: 'pin'`) or took out (`'takeOut'`) in `folderId`. Where
- * the click's edit no longer stands — Undo, Discard — it is made again first, in the same step.
- * `readings` are every feature the click read. Needs the plan as applied. A folder gone since
- * — Undo — changes nothing.
+ * `tag`, which a left click pinned (`target: 'pin'`) or left in the folder (`'add'`), or a right
+ * click took out (`'takeOut'`), in `folderId`. Where the click's edit no longer stands — Undo,
+ * Discard — it is made again first, in the same step. Needs the plan as applied. A folder gone
+ * since — Undo — changes nothing.
  */
  | {
     kind: 'choosePinReading';
     tag: string;
-    target: 'pin' | 'takeOut';
+    target: 'pin' | 'add' | 'takeOut';
     reading: string;
-    readings: ReadonlyArray<string>;
     folderId: string;
 }
 /**
@@ -1229,9 +1230,13 @@ declare const withPin: (plan: Constraints, tag: string, pinned: ReadonlyArray<Dr
     replaced: Array<string>;
     unignored: Array<number>;
 };
-/** What a click does to its feature: pin it in the folder, or take it out — unpinned. */
-type PinTarget = 'pin' | 'takeOut';
-/** What a click made of a feature since the plan was saved: pinned in the folder, or taken out. */
+/**
+ * What a click does to its feature: a left click pins it in the folder, or — in it already —
+ * leaves it there (`add`: a pick among its readings adds another); a right click takes it out,
+ * unpinned.
+ */
+type PinTarget = 'pin' | 'add' | 'takeOut';
+/** What a click made of a feature: pinned in the folder, left in it, or taken out. */
 interface PinChange {
     tag: string;
     target: PinTarget;
@@ -1262,15 +1267,12 @@ declare const folderClick: (plan: Constraints, feature: {
 };
 /**
  * A line's choice among the features its click read. On a pin: itself, or another pinned in its
- * place. On a feature taken out: it stays out, and at most one other is pinned instead — choosing
- * again, or choosing to take it out, lets the one before go. A feature that goes leaves the folder as
- * a click takes it out: unpinned, never put back where it was before. Answers the plan, and the
- * lines whose choice is made — a pin swapped away keeps its choice unmade, so undo brings it back
- * to be made.
- */
-declare const chooseReading: (plan: Constraints, saved: Constraints, line: PinChange, reading: string, 
-/** The features its click read, the line's among them. */
-read: ReadonlyArray<string>, folder: {
+ * place. On a feature left in the folder (`add`): itself, or another pinned there too — as any pin,
+ * replacing the pins it covers. On a feature taken out: itself, or another taken out in its place,
+ * the line's pinned back. Answers the plan, and the lines whose choice is made — a pin swapped away
+ * keeps its choice unmade, so undo brings it back to be made.
+ */
+declare const chooseReading: (plan: Constraints, saved: Constraints, line: PinChange, reading: string, folder: {
     id: string;
     direction: PlanDirection;
 }, context: PinContext) => {
@@ -1574,6 +1576,8 @@ declare const resultsView: ({ plan, constraints, part, }: {
     constraints: Pick<Constraints, "setups"> | null;
     part: PlanPart;
 }) => ResultsView;
+/** Whether a setup machines a feature, by tag in any case: lists it, as more than not machined. */
+declare const machines: (setup: ResultsSetupView, tag: string) => boolean;
 /** The setup a feature is machined in, by tag in any case: the first listing it, or null. */
 declare const setupOf: (setups: ReadonlyArray<ResultsSetupView>, tag: string) => ResultsSetupView | null;
 
@@ -1865,4 +1869,4 @@ declare const removeLibrary: (crib: ToolCrib, id: string) => ToolCrib;
 /** The crib with two libraries' places swapped, every other entry left where it is. */
 declare const swapLibraries: (crib: ToolCrib, a: string, b: string) => ToolCrib;
 
-export { type ActionTarget, type AppFields, type AutomaticStock, BOX_ENVELOPE, COVERAGE_KINDS, COVERAGE_LABELS, type CheckContext, type CheckedDraft, type ConfirmCheck, type ConfirmContext, type Constraints, type ConstraintsCoverage, type Coverage, type CoverageFeature, type CoverageKind, DONE_COLOR, DRAFT_ACTION_KINDS, type DirectionAnalysis, type DirectionsKnown, type DraftAction, type DraftActionKind, type DraftFacts, type DraftFolder, type DraftResult, type DraftSetup, type DropAt, type Edited, type EnginePlan, type EnginePlanAction, type EnginePlanSetup, FLAT_BAR_FIELDS, type Face, type FaceGroup, type FaceHatch, type FacePaint, type FeatureBore, type FeatureGroupView, type FixedBoxCheck, type FixedStock, type FlatFolder, type FolderFeature, type Frame, HISTORY, type Hold, IGNORE, type IgnoreMode, type IgnoredAs, type Landing, MAX_DEPTH, MAX_NAME, MAX_SETUPS, type ModelAxis, type ModelBox, type ModelCylinder, NO_FIRST_FOLDER, type NotMachinedFeature, type NotMachinedReason, type NotMachinedWhy, OTHER_FOLDER_COLOR, PART_ROW, PRECISION, type PinChange, type PinContext, type PinEdit, type Pinned, type PinnedFeature, type PlacedFolder, type PlanCheck, type PlanDirection, type PlanFeatureRow, type PlanHighlight, type PlanIssue, type PlanOrientationView, type PlanPart, type PlanReading, type PlanRules, type PlanSession, type PlanSetupView, type PlannedSetup$1 as PlannedSetup, type PlannedSetupView, type Projection, type Quantity, REASON_SHORT, ROUND_STOCK_FIELDS, type ReadingAt, type ReadingContext, type ReadingScope, type ResultsCoverage, type ResultsFeatureRow, type ResultsSetupView, type ResultsView, STOCK_LABELS, type SessionEvent, type SessionRules, type SetupPlan, type SetupProcess, type ShowTarget, type SplitRegion, type StatedOrientation, type Statement, type StockOption, type StockPosition, TILTED_FIRST_FOLDER, type ToolCrib, type ToolCribEntry, UNMACHINED_FACE_COLOR, type Units, type UnmachinedMark, actionsFor, addFolder, addLibrary, addSetup, allClear, allFolders, applyDraftAction, areaOf, axisAlong, canRedo, canUndo, changedSinceResults, chooseReading, classifyFaces, confirmChecks, copyDirection, cribOf, cribUntouched, currentFor, defaultStock, densityUnit, describeClause, directionAnalysis, draftView, echoesStock, faceRegions, facesByRegion, featureGroups, featureTypeLabel, featureTypePlural, featuresAt, findPlaced, fixedBoxCheck, fixedBoxPlacement, flattenFolders, folderClick, folderPath, foldersFromPlan, formatArea, formatDimensions, formatFeed, formatLength, formatSurfaceSpeed, formatWeight, frameFacing, framesOf, fromInput, gapAt, groupFaces, heightOf, holdsFor, ignoreClick, ignoreEdit, ignoreSelection, ignoredAs, ignoredAsSaved, implicitLibraryIds, indexedFor, isDirection, isFallback, isFromBelow, isHeld, isHoleType, isIndexed, isUnits, liftLoneFolder, listsTag, moveFeature, moveFolder, moveSetup, moveWithin, nextFolderName, notFinishedIn, notFinishedOf, notMachinedOf, offeredLibraries, parseDraftSetups, parseStock, parseToolLength, pinEdit, pinFrom, pinHomes, pinInto, pinOf, pinTargetOf, pinnedIn, pinsWhere, placedAlong, placedFolders, planChecks, planCounts, planFromResults, planHatch, planPaint, planRunOf, planSession, planTags, planView, projectFolder, readingDetail, readingOf, readingsFor, reasonLine, refusalClauses, regionLabel, removeFolder, removeFolders, removeLibrary, renameFolder, replacedBy, restoreFeature, resultsView, roundTo, rowsOf, sameDirection, sameJson, sameStock, setSetupProcess, setToolOrientation, setupOf, sortedKeys, startSession, startingLibrary, stateOf, statementOf, stepFor, stockEdited, stockPlacement, stockRequest, suitsMaterial, swapLibraries, tagKey, tagSet, takeBack, takeBackIgnore, toInput, toStored, unignoreEdit, unignorePinned, unignoredNote, unpinFeature, unpinnedNote, whyOf, whyText, withFolders, withIgnored, withPin, withoutIgnored };
+export { type ActionTarget, type AppFields, type AutomaticStock, BOX_ENVELOPE, COVERAGE_KINDS, COVERAGE_LABELS, type CheckContext, type CheckedDraft, type ConfirmCheck, type ConfirmContext, type Constraints, type ConstraintsCoverage, type Coverage, type CoverageFeature, type CoverageKind, DONE_COLOR, DRAFT_ACTION_KINDS, type DirectionAnalysis, type DirectionsKnown, type DraftAction, type DraftActionKind, type DraftFacts, type DraftFolder, type DraftResult, type DraftSetup, type DropAt, type Edited, type EnginePlan, type EnginePlanAction, type EnginePlanSetup, FLAT_BAR_FIELDS, type Face, type FaceGroup, type FaceHatch, type FacePaint, type FeatureBore, type FeatureGroupView, type FixedBoxCheck, type FixedStock, type FlatFolder, type FolderFeature, type Frame, HISTORY, type Hold, IGNORE, type IgnoreMode, type IgnoredAs, type Landing, MAX_DEPTH, MAX_NAME, MAX_SETUPS, type ModelAxis, type ModelBox, type ModelCylinder, NO_FIRST_FOLDER, type NotMachinedFeature, type NotMachinedReason, type NotMachinedWhy, OTHER_FOLDER_COLOR, PART_ROW, PRECISION, type PinChange, type PinContext, type PinEdit, type Pinned, type PinnedFeature, type PlacedFolder, type PlanCheck, type PlanDirection, type PlanFeatureRow, type PlanHighlight, type PlanIssue, type PlanOrientationView, type PlanPart, type PlanReading, type PlanRules, type PlanSession, type PlanSetupView, type PlannedSetup$1 as PlannedSetup, type PlannedSetupView, type Projection, type Quantity, REASON_SHORT, ROUND_STOCK_FIELDS, type ReadingAt, type ReadingContext, type ReadingScope, type ResultsCoverage, type ResultsFeatureRow, type ResultsSetupView, type ResultsView, STOCK_LABELS, type SessionEvent, type SessionRules, type SetupPlan, type SetupProcess, type ShowTarget, type SplitRegion, type StatedOrientation, type Statement, type StockOption, type StockPosition, TILTED_FIRST_FOLDER, type ToolCrib, type ToolCribEntry, UNMACHINED_FACE_COLOR, type Units, type UnmachinedMark, actionsFor, addFolder, addLibrary, addSetup, allClear, allFolders, applyDraftAction, areaOf, axisAlong, canRedo, canUndo, changedSinceResults, chooseReading, classifyFaces, confirmChecks, copyDirection, cribOf, cribUntouched, currentFor, defaultStock, densityUnit, describeClause, directionAnalysis, draftView, echoesStock, faceRegions, facesByRegion, featureGroups, featureTypeLabel, featureTypePlural, featuresAt, findPlaced, fixedBoxCheck, fixedBoxPlacement, flattenFolders, folderClick, folderPath, foldersFromPlan, formatArea, formatDimensions, formatFeed, formatLength, formatSurfaceSpeed, formatWeight, frameFacing, framesOf, fromInput, gapAt, groupFaces, heightOf, holdsFor, ignoreClick, ignoreEdit, ignoreSelection, ignoredAs, ignoredAsSaved, implicitLibraryIds, indexedFor, isDirection, isFallback, isFromBelow, isHeld, isHoleType, isIndexed, isUnits, liftLoneFolder, listsTag, machines, moveFeature, moveFolder, moveSetup, moveWithin, nextFolderName, notFinishedIn, notFinishedOf, notMachinedOf, offeredLibraries, parseDraftSetups, parseStock, parseToolLength, pinEdit, pinFrom, pinHomes, pinInto, pinOf, pinTargetOf, pinnedIn, pinsWhere, placedAlong, placedFolders, planChecks, planCounts, planFromResults, planHatch, planPaint, planRunOf, planSession, planTags, planView, projectFolder, readingDetail, readingOf, readingsFor, reasonLine, refusalClauses, regionLabel, removeFolder, removeFolders, removeLibrary, renameFolder, replacedBy, restoreFeature, resultsView, roundTo, rowsOf, sameDirection, sameJson, sameStock, setSetupProcess, setToolOrientation, setupOf, sortedKeys, startSession, startingLibrary, stateOf, statementOf, stepFor, stockEdited, stockPlacement, stockRequest, suitsMaterial, swapLibraries, tagKey, tagSet, takeBack, takeBackIgnore, toInput, toStored, unignoreEdit, unignorePinned, unignoredNote, unpinFeature, unpinnedNote, whyOf, whyText, withFolders, withIgnored, withPin, withoutIgnored };

package/dist/index.js

@@ -63,7 +63,16 @@ var kindOf = (face, ignored, input) => {
 };
 var RANKS = [
   ["blind_hole", "through_hole", "filleted_blind_hole"],
-  ["pocket", "open_pocket", "boss", "filleted_boss", "undercut_tslot", "undercut_dovetail", "sink"],
+  [
+    "pocket",
+    "open_pocket",
+    "boss",
+    "filleted_boss",
+    "circular_wall",
+    "undercut_tslot",
+    "undercut_dovetail",
+    "sink"
+  ],
   ["chamfer", "inner_fillet", "outer_fillet", "contour_surface", "slanted_face"],
   ["wall", "face"],
   ["profile"]
@@ -1028,14 +1037,15 @@ var takeBackIgnore = (plan, saved, regions, context) => ({
   ...ignoredAsSaved(plan, saved, regions, context.kernel)
 });
 var ignoreClick = ({
-  region,
   ignored,
-  regions
+  regions,
+  remove
 }) => {
-  if (ignored.has(region)) {
-    return { kind: "unignore", regions: regions.filter((each) => ignored.has(each)) };
+  if (remove) {
+    const going = regions.filter((each) => ignored.has(each));
+    return going.length > 0 ? { kind: "unignore", regions: going } : null;
   }
-  return { kind: "ignore", regions: [...regions] };
+  return regions.every((each) => ignored.has(each)) ? null : { kind: "ignore", regions: [...regions] };
 };
 
 // src/engine-plan.ts
@@ -1466,44 +1476,27 @@ var pinHere = (plan, tag, folderId, context) => {
   const pinned2 = pinEdit(plan, tag, { folderId }, context);
   return "refused" in pinned2 ? { intent: plan, unignored: [] } : pinned2;
 };
-var chooseReading = (plan, saved, line, reading, read, folder, context) => {
-  const choice = { plan, saved, line, reading, read, folder, context };
-  return line.target === "pin" ? chosenForPin(choice) : chosenForTakeOut(choice);
-};
-var chosenForPin = ({
-  plan,
-  saved,
-  line,
-  reading,
-  folder,
-  context
-}) => {
+var chooseReading = (plan, saved, line, reading, folder, context) => {
   if (reading === line.tag) {
     return { intent: plan, chosen: [reading] };
   }
-  const left = leaving(plan, saved, line.tag, context);
-  return { intent: pinHere(left, reading, folder.id, context).intent, chosen: [reading] };
+  const choose = CHOSEN_FOR[line.target];
+  return { intent: choose({ plan, saved, line, reading, folder, context }), chosen: [reading] };
 };
-var chosenForTakeOut = (choice) => {
-  const { plan, saved, line, reading, folder, context } = choice;
-  const cleared = chosenBefore(choice).reduce((all, tag) => leaving(all, saved, tag, context), plan);
-  const out = pinnedIn(cleared.setups, line.tag) === pinnedIn(plan.setups, line.tag) ? cleared : letGo(cleared, line.tag);
-  return {
-    intent: reading === line.tag ? out : pinHere(out, reading, folder.id, context).intent,
-    chosen: reading === line.tag ? [line.tag] : [reading, line.tag]
-  };
+var chosenForPin = ({ plan, saved, line, reading, folder, context }) => {
+  const left = letGo(takeBack(plan, saved, line.tag, context), line.tag);
+  return pinHere(left, reading, folder.id, context).intent;
+};
+var chosenForAdd = ({ plan, reading, folder, context }) => pinHere(plan, reading, folder.id, context).intent;
+var chosenForTakeOut = ({ plan, line, reading, folder, context }) => {
+  const back = pinHere(plan, line.tag, folder.id, context).intent;
+  return pinnedIn(back.setups, reading) === folder.id ? { ...back, setups: unpinFeature(back.setups, folder.id, reading) } : back;
+};
+var CHOSEN_FOR = {
+  pin: chosenForPin,
+  add: chosenForAdd,
+  takeOut: chosenForTakeOut
 };
-var leaving = (plan, saved, tag, context) => letGo(takeBack(plan, saved, tag, context), tag);
-var chosenBefore = ({
-  plan,
-  saved,
-  line,
-  reading,
-  read,
-  folder
-}) => read.filter(
-  (each) => each !== line.tag && each !== reading && pinnedIn(plan.setups, each) === folder.id && pinnedIn(saved.setups, each) !== folder.id
-);
 var readingOf = (folders, coverage) => {
   const faces = facesByRegion(coverage);
   return { folders, kindOf: (region) => faces.get(region)?.kind ?? "open" };
@@ -1763,7 +1756,6 @@ var applyChoosePinReading = ({ draft, rules, saved }, action) => {
     saved,
     { tag: action.tag, target: action.target },
     action.reading,
-    action.readings,
     { id: action.folderId, direction: placed.direction },
     rules
   );
@@ -1771,7 +1763,7 @@ var applyChoosePinReading = ({ draft, rules, saved }, action) => {
 };
 var withClickStanding = (draft, action, placed, rules) => {
   const inFolder = pinnedIn(draft.setups, action.tag) === action.folderId;
-  const standing = inFolder !== (action.target === "takeOut");
+  const standing = action.target === "add" || inFolder !== (action.target === "takeOut");
   if (standing) {
     return draft;
   }
@@ -2351,12 +2343,11 @@ var markOf = (key, notFinished, notMachined) => {
   }
   return notMachined.has(key) ? "notMachined" : false;
 };
-var setupOf = (setups, tag) => {
+var machines = (setup, tag) => {
   const key = tag.toLowerCase();
-  return setups.find(
-    (setup) => setup.rows.some((row) => row.tag.toLowerCase() === key && row.mark !== "notMachined")
-  ) ?? null;
+  return setup.rows.some((row) => row.tag.toLowerCase() === key && row.mark !== "notMachined");
 };
+var setupOf = (setups, tag) => setups.find((setup) => machines(setup, tag)) ?? null;
 
 // src/units.ts
 import { MM_PER_INCH } from "@toolpath/tool-support";
@@ -2867,6 +2858,7 @@ export {
   isUnits,
   liftLoneFolder,
   listsTag,
+  machines,
   moveFeature,
   moveFolder,
   moveSetup,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolpath/plan",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Plan mode for Toolpath: the plan a person states (setups, folders, pinned features, ignored faces), every edit to it, and the plan Toolpath makes from it. Logic only; views belong in @toolpath/ui",
   "license": "MIT",
   "engines": {
@@ -41,7 +41,7 @@
     "tsup": "8.5.1",
     "typescript": "5.9.3",
     "vitest": "4.1.10",
-    "@toolpath/api": "^0.9.0"
+    "@toolpath/api": "^0.10.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --clean",