@toolpath/tool-support 0.1.0 → 0.3.0

package/dist/forms.d.ts

@@ -128,3 +128,17 @@ export type ToolForm = (typeof TOOL_FORMS)[number]['value'] | 'other';
 /** The forms that mill — the ones a flute-count suggestion makes sense for. */
 export declare const MILLING_FORMS: ReadonlySet<ToolForm>;
 export declare const isToolForm: (value: string) => value is ToolForm;
+/**
+ * The forms that cut a thread with a square-driven tool — the taps.
+ *
+ * Derived from {@link TOOL_FORMS} by the vocabulary's own naming, the way
+ * {@link MILLING_FORMS} is derived from its `group`. A rostered pair of strings
+ * beside the list would be a second copy of the vocabulary to disagree with it.
+ * `'tapered mill'` is not matched: the prefix is `'tap '` with the space.
+ *
+ * `'Hole making'` is the wrong axis here — it holds drills, reamers and boring
+ * bars — which is why this cannot be a `group` filter.
+ */
+export declare const TAP_FORMS: ReadonlySet<ToolForm>;
+/** Whether a form is a tap, and therefore driven by a square. */
+export declare const isTapForm: (form: string) => boolean;

package/dist/forms.js

@@ -42,3 +42,17 @@ export const TOOL_FORMS = [
 /** The forms that mill — the ones a flute-count suggestion makes sense for. */
 export const MILLING_FORMS = new Set(TOOL_FORMS.filter((form) => form.group === 'Milling').map((form) => form.value));
 export const isToolForm = (value) => value === 'other' || TOOL_FORMS.some((form) => form.value === value);
+/**
+ * The forms that cut a thread with a square-driven tool — the taps.
+ *
+ * Derived from {@link TOOL_FORMS} by the vocabulary's own naming, the way
+ * {@link MILLING_FORMS} is derived from its `group`. A rostered pair of strings
+ * beside the list would be a second copy of the vocabulary to disagree with it.
+ * `'tapered mill'` is not matched: the prefix is `'tap '` with the space.
+ *
+ * `'Hole making'` is the wrong axis here — it holds drills, reamers and boring
+ * bars — which is why this cannot be a `group` filter.
+ */
+export const TAP_FORMS = new Set(TOOL_FORMS.filter((form) => form.value.startsWith('tap ')).map((form) => form.value));
+/** Whether a form is a tap, and therefore driven by a square. */
+export const isTapForm = (form) => TAP_FORMS.has(form);

package/dist/holding.d.ts

@@ -129,6 +129,19 @@ export interface Collet {
      * to be "nobody has said" rather than an invented grip rule.
      */
     readonly clampLength: number | null;
+    /**
+     * The square drive this collet grips, across flats, in millimetres.
+     *
+     * A tap collet's bore is not round: it carries a square that drives the tap,
+     * so the part it takes is a tap and nothing else. `null` — and absent — is
+     * "nobody has said", which is every collet whose vendor publishes no square,
+     * and those go on taking anything their capacity band fits.
+     *
+     * Optional rather than required because {@link Collet} is a shape consumers
+     * build, and a collet crib assembled before this existed states the same
+     * thing by saying nothing.
+     */
+    readonly squareSize?: number | null;
     readonly provenance?: ProvenanceMap;
 }
 /**
@@ -176,8 +189,13 @@ export declare const gripsShank: (collet: Pick<Collet, "clampMin" | "clampMax">,
  * fit.** This is the one place the domain differs from "what is not stated is
  * not checked", because here the unchecked case is a cutter falling out of a
  * spindle.
+ *
+ * `form` is read only by {@link Collet.squareSize}'s gate and is optional for
+ * that reason: a caller with no form in hand keeps the answer it had for every
+ * collet whose vendor publishes no square, which is all of them but the tap
+ * collets.
  */
-export declare const holderTakesTool: (holder: Pick<Holder, "clamping" | "colletSeries" | "boreDiameter">, collet: Collet | null, tool: Pick<Tool, "geometry">) => boolean;
+export declare const holderTakesTool: (holder: Pick<Holder, "clamping" | "colletSeries" | "boreDiameter">, collet: Collet | null, tool: Pick<Tool, "geometry"> & Partial<Pick<Tool, "form">>) => boolean;
 /**
  * The furthest a tool can stand out of its holder, in millimetres: overall
  * length less the length that has to stay gripped.

package/dist/holding.js

@@ -32,6 +32,7 @@
  */
 import { DEFAULT_STICKOUT_POLICY, stickoutRange, } from './stickout.js';
 import { DEFAULT_CLAMPING } from './clamping.js';
+import { isTapForm } from './forms.js';
 /**
  * Which of the two holder forms this is.
  *
@@ -55,6 +56,27 @@ export const colletFitsHolder = (collet, holder) => holder.clamping === 'collet'
 const GRIP_TOLERANCE = 1e-6;
 /** Whether a collet grips a given shank diameter, in millimetres. */
 export const gripsShank = (collet, shank) => shank >= collet.clampMin - GRIP_TOLERANCE && shank <= collet.clampMax + GRIP_TOLERANCE;
+/**
+ * Whether the collet's drive suits the tool, which is a second question from
+ * whether it grips the shank.
+ *
+ * A tap collet's square holds one shank diameter exactly, so a shank test alone
+ * says yes to an end mill of that size — and an end mill in a square bore is
+ * held by nothing. The square is the vendor's own published dimension, so a
+ * collet that states one takes a tap and a collet that states none is unchanged.
+ *
+ * The converse is deliberately **not** enforced: a tap in a plain round collet
+ * is how most shops tap, and refusing it would be this package inventing a
+ * policy no vendor stated.
+ */
+const driveTakesTool = (collet, tool) => {
+    const square = collet.squareSize;
+    if (square === null || square === undefined)
+        return true;
+    // An unstated form is nobody having said, and nobody-has-said does not go in
+    // a square bore — the same direction an unstated shank is refused in.
+    return tool.form !== undefined && isTapForm(tool.form);
+};
 /**
  * Whether a bore, shrink or hydraulic holder's one diameter is this shank.
  *
@@ -70,6 +92,11 @@ const boreTakesShank = (bore, shank) => Math.abs(bore - shank) <= GRIP_TOLERANCE
  * fit.** This is the one place the domain differs from "what is not stated is
  * not checked", because here the unchecked case is a cutter falling out of a
  * spindle.
+ *
+ * `form` is read only by {@link Collet.squareSize}'s gate and is optional for
+ * that reason: a caller with no form in hand keeps the answer it had for every
+ * collet whose vendor publishes no square, which is all of them but the tap
+ * collets.
  */
 export const holderTakesTool = (holder, collet, tool) => {
     const shank = tool.geometry.SFDM;
@@ -77,7 +104,10 @@ export const holderTakesTool = (holder, collet, tool) => {
         return false;
     }
     if (holder.clamping === 'collet') {
-        return collet !== null && colletFitsHolder(collet, holder) && gripsShank(collet, shank);
+        return (collet !== null &&
+            colletFitsHolder(collet, holder) &&
+            gripsShank(collet, shank) &&
+            driveTakesTool(collet, tool));
     }
     // A holder that states no clamping mode falls here and is refused: absent
     // means nobody has said, and nobody-has-said takes no tool.

package/dist/index.d.ts

@@ -47,8 +47,8 @@
 export { MM_PER_INCH, UNIT_ABBREVIATION, UNIT_SYSTEMS, convertArea, convertLength, decimalsFor, formatArea, formatLength, type UnitSystem, } from './units.js';
 export { PROVENANCE, type Provenance, type ProvenanceMap } from './provenance.js';
 export { GEOMETRY_FIELDS, convertGeometry, geometryField, isLengthField, type Geometry, type GeometryCode, type GeometryField, type GeometryUnit, } from './geometry.js';
-export { MILLING_FORMS, TOOL_FORMS, isToolForm, type ToolForm, type ToolFormEntry, } from './forms.js';
-export { hasNeck, shankOf, type Shank, type Tool } from './tool.js';
+export { MILLING_FORMS, TAP_FORMS, TOOL_FORMS, isTapForm, isToolForm, type ToolForm, type ToolFormEntry, } from './forms.js';
+export { THREAD_METHODS, hasNeck, isThreadMethod, shankOf, type Shank, type ThreadMethod, type Tool, } from './tool.js';
 export { PROFILES_VERSION, belowGageLine, type HolderProfile, type ProfileDatum, type ProfilePoint, } from './profile.js';
 export { canHold, colletFitsHolder, defaultStickout, gripRanges, gripsAnyShank, gripsShank, holdBand, holderTakesTool, isHolderProfile, maxStickout, stickoutLimits, type Assembly, type Clamping, type Collet, type GripRanges, type HoldBand, type Holder, } from './holding.js';
 export { DEFAULT_CLAMPING, clampShortfall, clampWanted, headLength, heldDiameter, type ClampingRule, } from './clamping.js';

package/dist/index.js

@@ -47,8 +47,8 @@
 export { MM_PER_INCH, UNIT_ABBREVIATION, UNIT_SYSTEMS, convertArea, convertLength, decimalsFor, formatArea, formatLength, } from './units.js';
 export { PROVENANCE } from './provenance.js';
 export { GEOMETRY_FIELDS, convertGeometry, geometryField, isLengthField, } from './geometry.js';
-export { MILLING_FORMS, TOOL_FORMS, isToolForm, } from './forms.js';
-export { hasNeck, shankOf } from './tool.js';
+export { MILLING_FORMS, TAP_FORMS, TOOL_FORMS, isTapForm, isToolForm, } from './forms.js';
+export { THREAD_METHODS, hasNeck, isThreadMethod, shankOf, } from './tool.js';
 export { PROFILES_VERSION, belowGageLine, } from './profile.js';
 export { canHold, colletFitsHolder, defaultStickout, gripRanges, gripsAnyShank, gripsShank, holdBand, holderTakesTool, isHolderProfile, maxStickout, stickoutLimits, } from './holding.js';
 export { DEFAULT_CLAMPING, clampShortfall, clampWanted, headLength, heldDiameter, } from './clamping.js';

package/dist/tool.d.ts

@@ -24,11 +24,49 @@
  */
 import type { Geometry } from './geometry.js';
 import type { ProvenanceMap } from './provenance.js';
+/**
+ * How a tap makes its thread: by cutting it away, or by displacing material
+ * into it.
+ *
+ * **A second axis beside {@link Tool.form}, not two more forms.**
+ * `forms.ts`'s vocabulary is Fusion's own, so that a tool exported there lands
+ * on the type it already has, and Fusion has no form-tap type — a form tap is a
+ * `tap right hand` there like any other. Adding `form tap right hand` would buy
+ * a filter chip and cost that guarantee. It is the same call
+ * `tool-scraper`'s `families/kennametal.ts` makes for keeping a holder's
+ * `contact` off its `taper`: two facts about one part are two fields.
+ *
+ * The two are genuinely different tools. A former needs a larger hole, evacuates
+ * no chip, and runs at its own feed; a cut tap does none of that. Nothing here
+ * branches on it yet — a tap goes in on the hole's axis either way, and
+ * `tool-drawing` has no publishable shape for either one's lead — but a
+ * consumer choosing or feeding a tool cannot ask the question at all until the
+ * fact is carried.
+ */
+export type ThreadMethod = 'cutting' | 'forming';
+/**
+ * The methods, in the order a control offers them.
+ *
+ * A list beside the union for the reason `PROVENANCE` is one: `tool-scraper`
+ * validates a family's declared value against it rather than redeclaring the
+ * two strings, and a filter panel offers it. Cutting leads because it is what
+ * most of a catalog is.
+ */
+export declare const THREAD_METHODS: readonly ["cutting", "forming"];
+export declare const isThreadMethod: (value: string) => value is ThreadMethod;
 export interface Tool {
     /** The CAM-library name for what the tool is: `flat end mill`, `drill`, `slot mill`. */
     readonly form: string;
     /** What a machinist calls this one tool — a catalog number, usually. */
     readonly label?: string;
+    /**
+     * How this tap makes its thread, where it is a tap and somebody has said.
+     *
+     * Optional, and **absent is nobody having said** rather than a claim of
+     * cutting — the rule `holding.ts`'s `Clamping` keeps on a holder and `shankOf` keeps
+     * on a shank. A non-tap carries none, because the question does not apply.
+     */
+    readonly threadMethod?: ThreadMethod;
     readonly geometry: Geometry;
     readonly provenance?: ProvenanceMap;
 }

package/dist/tool.js

@@ -28,6 +28,16 @@
  * 9.525 on the collet's sheet and 9.524999999999999 on the tool's.
  */
 const EPSILON = 1e-6;
+/**
+ * The methods, in the order a control offers them.
+ *
+ * A list beside the union for the reason `PROVENANCE` is one: `tool-scraper`
+ * validates a family's declared value against it rather than redeclaring the
+ * two strings, and a filter panel offers it. Cutting leads because it is what
+ * most of a catalog is.
+ */
+export const THREAD_METHODS = ['cutting', 'forming'];
+export const isThreadMethod = (value) => THREAD_METHODS.some((method) => method === value);
 /**
  * Whether the section between the flutes and the shank is a neck: a stated
  * shoulder past the flutes, narrower than the shank.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolpath/tool-support",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "The cutting-tool domain: what a tool, holder, collet and assembly are",
   "license": "MIT",
   "engines": {
@@ -35,14 +35,14 @@
     "README.md"
   ],
   "sideEffects": false,
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "check-types": "tsc --noEmit",
-    "test": "vitest run"
-  },
   "devDependencies": {
     "@types/node": "24.10.1",
     "typescript": "5.9.3",
     "vitest": "4.1.10"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run"
   }
-}
+}