@faicad/sheetmetal 0.13.0

package/dist/allowanceFns.d.ts

@@ -0,0 +1,42 @@
+import { type Result } from '@faicad/faijs/brepjs-compat';
+import type { BendRule, SheetMetalWarning } from './types.js';
+/**
+ * Bend allowance — the developed (flat) length of material consumed by a bend,
+ * measured along the neutral axis. Resolution precedence (see
+ * {@link resolveBendAllowance}): a referenced bend table, then an explicit
+ * `rule.allowance` override, then the K-factor formula
+ * BA = (π/180)·|angle|·(R + K·T). An optional `onWarning` receives the clamp
+ * warning when a table query falls outside its tabulated range.
+ * @param angleDeg the bend angle in degrees
+ * @param thickness the sheet thickness
+ * @param rule the bend rule used for the resolution
+ * @param onWarning optional callback receiving a clamp warning when a table query
+ * falls outside its tabulated range
+ * @returns a `Result<number>` — `ok` with the computed bend allowance on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export declare function bendAllowance(angleDeg: number, thickness: number, rule: BendRule, onWarning?: (warning: SheetMetalWarning) => void): Result<number>;
+/**
+ * Developed length of the bend region when flattened — the neutral-axis arc
+ * length that replaces the curved patch in the flat pattern. Identical to the
+ * bend allowance (kept distinct in name for the unfold call sites that consume
+ * it as a strip width), and routed through the same {@link resolveBendAllowance}
+ * resolution (table → explicit allowance → K-factor).
+ * @param angleDeg the bend angle in degrees
+ * @param thickness the sheet thickness
+ * @param rule the bend rule used for the resolution
+ * @param onWarning optional callback receiving a clamp warning when a table query
+ * falls outside its tabulated range
+ * @returns a `Result<number>` — `ok` with the developed length on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export declare function developedLength(angleDeg: number, thickness: number, rule: BendRule, onWarning?: (warning: SheetMetalWarning) => void): Result<number>;
+/**
+ * Neutral-axis radius R + K·T (the radius the developed arc length is measured at).
+ * @param thickness the sheet thickness
+ * @param rule the bend rule providing `innerRadius` and `kFactor`
+ * @returns a `Result<number>` — `ok` with the neutral-axis radius on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export declare function neutralRadius(thickness: number, rule: BendRule): Result<number>;
+//# sourceMappingURL=allowanceFns.d.ts.map

package/dist/allowanceFns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allowanceFns.d.ts","sourceRoot":"","sources":["../src/allowanceFns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAA4B,MAAM,6BAA6B,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAe9D;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAC/C,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAC/C,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAO/E"}

package/dist/allowanceFns.js

@@ -0,0 +1,63 @@
+import { ok, err, validationError } from '@faicad/faijs/brepjs-compat';
+import { resolveBendAllowance } from './bendTableFns.js';
+function validateRule(rule) {
+    if (!Number.isFinite(rule.innerRadius) || rule.innerRadius < 0) {
+        return err(validationError('INVALID_RADIUS', `innerRadius must be a finite, non-negative number, got ${rule.innerRadius}`));
+    }
+    if (!Number.isFinite(rule.kFactor) || rule.kFactor < 0 || rule.kFactor > 1) {
+        return err(validationError('INVALID_K_FACTOR', `kFactor must be in [0, 1], got ${rule.kFactor}`));
+    }
+    return ok(undefined);
+}
+/**
+ * Bend allowance — the developed (flat) length of material consumed by a bend,
+ * measured along the neutral axis. Resolution precedence (see
+ * {@link resolveBendAllowance}): a referenced bend table, then an explicit
+ * `rule.allowance` override, then the K-factor formula
+ * BA = (π/180)·|angle|·(R + K·T). An optional `onWarning` receives the clamp
+ * warning when a table query falls outside its tabulated range.
+ * @param angleDeg the bend angle in degrees
+ * @param thickness the sheet thickness
+ * @param rule the bend rule used for the resolution
+ * @param onWarning optional callback receiving a clamp warning when a table query
+ * falls outside its tabulated range
+ * @returns a `Result<number>` — `ok` with the computed bend allowance on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export function bendAllowance(angleDeg, thickness, rule, onWarning) {
+    return resolveBendAllowance(rule, angleDeg, thickness, onWarning);
+}
+/**
+ * Developed length of the bend region when flattened — the neutral-axis arc
+ * length that replaces the curved patch in the flat pattern. Identical to the
+ * bend allowance (kept distinct in name for the unfold call sites that consume
+ * it as a strip width), and routed through the same {@link resolveBendAllowance}
+ * resolution (table → explicit allowance → K-factor).
+ * @param angleDeg the bend angle in degrees
+ * @param thickness the sheet thickness
+ * @param rule the bend rule used for the resolution
+ * @param onWarning optional callback receiving a clamp warning when a table query
+ * falls outside its tabulated range
+ * @returns a `Result<number>` — `ok` with the developed length on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export function developedLength(angleDeg, thickness, rule, onWarning) {
+    return resolveBendAllowance(rule, angleDeg, thickness, onWarning);
+}
+/**
+ * Neutral-axis radius R + K·T (the radius the developed arc length is measured at).
+ * @param thickness the sheet thickness
+ * @param rule the bend rule providing `innerRadius` and `kFactor`
+ * @returns a `Result<number>` — `ok` with the neutral-axis radius on success,
+ * or `err` with a `validationError` when the inputs are invalid
+ */
+export function neutralRadius(thickness, rule) {
+    if (!Number.isFinite(thickness) || thickness <= 0) {
+        return err(validationError('INVALID_THICKNESS', `thickness must be a finite, positive number, got ${thickness}`));
+    }
+    const ruleCheck = validateRule(rule);
+    if (!ruleCheck.ok)
+        return ruleCheck;
+    return ok(rule.innerRadius + rule.kFactor * thickness);
+}
+//# sourceMappingURL=allowanceFns.js.map

package/dist/allowanceFns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allowanceFns.js","sourceRoot":"","sources":["../src/allowanceFns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEzD,SAAS,YAAY,CAAC,IAAc;IAClC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC;QAC/D,OAAO,GAAG,CACR,eAAe,CAAC,gBAAgB,EAAE,0DAA0D,IAAI,CAAC,WAAW,EAAE,CAAC,CAChH,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;QAC3E,OAAO,GAAG,CAAC,eAAe,CAAC,kBAAkB,EAAE,kCAAkC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IACD,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAgB,EAChB,SAAiB,EACjB,IAAc,EACd,SAAgD;IAEhD,OAAO,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAgB,EAChB,SAAiB,EACjB,IAAc,EACd,SAAgD;IAEhD,OAAO,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB,EAAE,IAAc;IAC7D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,eAAe,CAAC,mBAAmB,EAAE,oDAAoD,SAAS,EAAE,CAAC,CAAC,CAAC;IACpH,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,SAAS,CAAC,EAAE;QAAE,OAAO,SAAS,CAAC;IACpC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;AACzD,CAAC","sourcesContent":["import { type Result, ok, err, validationError } from '@faicad/faijs/brepjs-compat';\nimport type { BendRule, SheetMetalWarning } from './types.js';\nimport { resolveBendAllowance } from './bendTableFns.js';\n\nfunction validateRule(rule: BendRule): Result<void> {\n  if (!Number.isFinite(rule.innerRadius) || rule.innerRadius < 0) {\n    return err(\n      validationError('INVALID_RADIUS', `innerRadius must be a finite, non-negative number, got ${rule.innerRadius}`)\n    );\n  }\n  if (!Number.isFinite(rule.kFactor) || rule.kFactor < 0 || rule.kFactor > 1) {\n    return err(validationError('INVALID_K_FACTOR', `kFactor must be in [0, 1], got ${rule.kFactor}`));\n  }\n  return ok(undefined);\n}\n\n/**\n * Bend allowance — the developed (flat) length of material consumed by a bend,\n * measured along the neutral axis. Resolution precedence (see\n * {@link resolveBendAllowance}): a referenced bend table, then an explicit\n * `rule.allowance` override, then the K-factor formula\n * BA = (π/180)·|angle|·(R + K·T). An optional `onWarning` receives the clamp\n * warning when a table query falls outside its tabulated range.\n * @param angleDeg the bend angle in degrees\n * @param thickness the sheet thickness\n * @param rule the bend rule used for the resolution\n * @param onWarning optional callback receiving a clamp warning when a table query\n * falls outside its tabulated range\n * @returns a `Result<number>` — `ok` with the computed bend allowance on success,\n * or `err` with a `validationError` when the inputs are invalid\n */\nexport function bendAllowance(\n  angleDeg: number,\n  thickness: number,\n  rule: BendRule,\n  onWarning?: (warning: SheetMetalWarning) => void\n): Result<number> {\n  return resolveBendAllowance(rule, angleDeg, thickness, onWarning);\n}\n\n/**\n * Developed length of the bend region when flattened — the neutral-axis arc\n * length that replaces the curved patch in the flat pattern. Identical to the\n * bend allowance (kept distinct in name for the unfold call sites that consume\n * it as a strip width), and routed through the same {@link resolveBendAllowance}\n * resolution (table → explicit allowance → K-factor).\n * @param angleDeg the bend angle in degrees\n * @param thickness the sheet thickness\n * @param rule the bend rule used for the resolution\n * @param onWarning optional callback receiving a clamp warning when a table query\n * falls outside its tabulated range\n * @returns a `Result<number>` — `ok` with the developed length on success,\n * or `err` with a `validationError` when the inputs are invalid\n */\nexport function developedLength(\n  angleDeg: number,\n  thickness: number,\n  rule: BendRule,\n  onWarning?: (warning: SheetMetalWarning) => void\n): Result<number> {\n  return resolveBendAllowance(rule, angleDeg, thickness, onWarning);\n}\n\n/**\n * Neutral-axis radius R + K·T (the radius the developed arc length is measured at).\n * @param thickness the sheet thickness\n * @param rule the bend rule providing `innerRadius` and `kFactor`\n * @returns a `Result<number>` — `ok` with the neutral-axis radius on success,\n * or `err` with a `validationError` when the inputs are invalid\n */\nexport function neutralRadius(thickness: number, rule: BendRule): Result<number> {\n  if (!Number.isFinite(thickness) || thickness <= 0) {\n    return err(validationError('INVALID_THICKNESS', `thickness must be a finite, positive number, got ${thickness}`));\n  }\n  const ruleCheck = validateRule(rule);\n  if (!ruleCheck.ok) return ruleCheck;\n  return ok(rule.innerRadius + rule.kFactor * thickness);\n}\n"]}

package/dist/api.d.ts

@@ -0,0 +1,312 @@
+/**
+ * Public API — short-named wrappers over the sheet-metal `*Fns` modules.
+ *
+ * These are the canonical entry points for the domain: they delegate to the
+ * underlying functional implementations without re-deriving any geometry, and
+ * preserve the `Result<T>` / warning-channel contract end to end. The fluent
+ * `sheetMetal()` facade in `./facade.js` is built on top of these.
+ */
+import { type Result, type Solid } from '@faicad/faijs/brepjs-compat';
+import { type AuthorSpec, type FlangeSpec } from './authorFns.js';
+import { type MiterPlane } from './miterFns.js';
+import { type SlotPlacement } from './tabFns.js';
+import { type DxfOptions } from './dxfFns.js';
+import { type NestOptions, type NestResult } from './nestFns.js';
+import { type BendTable } from './bendTableFns.js';
+import type { SheetMetalPart, FlatPattern, FlatInput, BendReport, BendRule, ReliefSpec, CutoutSpec, TabSpec, ContourFlangeSpec, LoftedFlangeSpec, HemSpec, JogSpec, UnfoldResult, SheetMetalWarning } from './types.js';
+/**
+ * Author a straight-bend part: a base flat plus folded-up flanges.
+ * @param spec - the part definition: base flat, material thickness, and the flange list to fold up.
+ * @returns a `Result<SheetMetalPart>` carrying the authored part, or the first error encountered.
+ */
+export declare function author(spec: AuthorSpec): Result<SheetMetalPart>;
+/**
+ * Extract the lone 3D solid of an authored part as its own `Result` terminal.
+ *
+ * `author`/`fold`/`hem` return the data model `SheetMetalPart`; its `.solid`
+ * field is the authored BREP solid. `.fai.js` statements cannot read nested
+ * member expressions (`p1.solid`), so this explicit terminal is the sanctioned
+ * way to pull the geometry out of a part.
+ * @param part - the sheet-metal part carrying the authored solid.
+ * @returns `Ok` with the part's surface, or `Err` (`NO_SOLID`) when the part
+ * has no authored solid yet (e.g. it was only built by `flatPattern`).
+ */
+export declare function solidOf(part: SheetMetalPart): Result<Solid>;
+/**
+ * Flatten an authored part into a developed flat pattern + bend report + warnings.
+ * @param part - the authored sheet-metal part to flatten.
+ * @returns a `Result<UnfoldResult>` with the flat pattern, bend report, and any warnings.
+ */
+export declare function unfold(part: SheetMetalPart): Result<UnfoldResult>;
+/**
+ * Unfold an imported sheet-metal solid that has no feature tree, by detecting its
+ * geometry (planar panels + cylindrical bends) numerically. `kFactor` defaults to
+ * the mid-surface neutral axis (0.5); supply a known material's K-factor to match
+ * its development.
+ * @param solid - the imported solid (B-rep) to unfold.
+ * @param opts - optional overrides; `opts.kFactor` sets the K-factor used for the bend allowance.
+ * @returns a `Result<UnfoldResult>` with the detected flat pattern, report, and any warnings.
+ */
+export declare function unfoldSolid(solid: Solid, opts?: {
+    kFactor?: number;
+}): Result<UnfoldResult>;
+/**
+ * Fold a flat pattern (region-tree) up into a 3D part — the inverse of {@link unfold}.
+ * @param input - the flat pattern (region tree) to fold up.
+ * @returns a `Result<SheetMetalPart>` carrying the folded 3D part, or the first error.
+ */
+export declare function fold(input: FlatInput): Result<SheetMetalPart>;
+/**
+ * Cut a part by an oriented plane, removing material on the `+normal` side.
+ * @param part - the sheet-metal part to cut.
+ * @param plane - the oriented cutting plane; material on the plane's `+normal` side is removed.
+ * @returns a `Result<SheetMetalPart>` carrying the mitered part, or the first error.
+ */
+export declare function miter(part: SheetMetalPart, plane: MiterPlane): Result<SheetMetalPart>;
+/**
+ * Auto-miter the shared corner of two flanges with an optional gap.
+ * @param part - the sheet-metal part whose corner is to be mitered.
+ * @param flangeIdA - id of the first flange meeting at the corner.
+ * @param flangeIdB - id of the second flange meeting at the corner.
+ * @param gap - optional gap (in millimetres) left between the two mitered edges; defaults to 0.
+ * @returns a `Result<SheetMetalPart>` carrying the mitered part, or the first error.
+ */
+export declare function miterCorner(part: SheetMetalPart, flangeIdA: string, flangeIdB: string, gap?: number): Result<SheetMetalPart>;
+/**
+ * Add a bend relief slot at each mid-edge end of a partial flange's bend line.
+ * @param part - the sheet-metal part to modify.
+ * @param flangeId - id of the partial flange whose bend-line ends get the relief.
+ * @param spec - optional relief specification overriding the defaults.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the relief added, or the first error.
+ */
+export declare function bendRelief(part: SheetMetalPart, flangeId: string, spec?: ReliefSpec): Result<SheetMetalPart>;
+/**
+ * Add a bend relief to every partial-span bend in the part.
+ * @param part - the sheet-metal part to modify.
+ * @param spec - optional relief specification applied to every partial bend.
+ * @returns a `Result<SheetMetalPart>` carrying the part with all reliefs added, or the first error.
+ */
+export declare function autoReliefs(part: SheetMetalPart, spec?: ReliefSpec): Result<SheetMetalPart>;
+/**
+ * Cut a corner relief notch at the shared corner of two adjacent flanges.
+ * @param part - the sheet-metal part to modify.
+ * @param flangeIdA - id of the first flange forming the corner.
+ * @param flangeIdB - id of the second flange forming the corner.
+ * @param spec - optional relief specification overriding the defaults.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the corner relief added, or the first error.
+ */
+export declare function relieveCorner(part: SheetMetalPart, flangeIdA: string, flangeIdB: string, spec?: ReliefSpec): Result<SheetMetalPart>;
+/**
+ * Punch a cutout (hole / slot / polygon) through a named flat region's thickness.
+ * @param part - the sheet-metal part to modify.
+ * @param spec - the cutout definition (kind, geometry, and target region).
+ * @returns a `Result<SheetMetalPart>` carrying the part with the cutout punched, or the first error.
+ */
+export declare function addCutout(part: SheetMetalPart, spec: CutoutSpec): Result<SheetMetalPart>;
+/**
+ * Punch a circular hole of `diameter` centred at region-local `(x, y)`.
+ * @param part - the sheet-metal part to modify.
+ * @param region - name of the flat region the hole is punched through.
+ * @param x - region-local X of the hole centre.
+ * @param y - region-local Y of the hole centre.
+ * @param diameter - hole diameter.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the hole punched, or the first error.
+ */
+export declare function addHole(part: SheetMetalPart, region: string, x: number, y: number, diameter: number): Result<SheetMetalPart>;
+/**
+ * Punch a slot (rectangular or obround) centred at region-local `(x, y)`.
+ * @param part - the sheet-metal part to modify.
+ * @param region - name of the flat region the slot is punched through.
+ * @param opts - slot geometry: centre `(x, y)`, `length`, `width`, optional `angleDeg` rotation, and `round` ends flag.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the slot punched, or the first error.
+ */
+export declare function addSlot(part: SheetMetalPart, region: string, opts: {
+    x: number;
+    y: number;
+    length: number;
+    width: number;
+    angleDeg?: number;
+    round?: boolean;
+}): Result<SheetMetalPart>;
+/**
+ * Punch an arbitrary polygon cutout from its region-local `points`.
+ * @param part - the sheet-metal part to modify.
+ * @param region - name of the flat region the polygon is punched through.
+ * @param points - region-local polygon vertices as `[x, y]` pairs.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the polygon cutout, or the first error.
+ */
+export declare function addPolygonCutout(part: SheetMetalPart, region: string, points: [number, number][]): Result<SheetMetalPart>;
+/**
+ * Fuse a rectangular tab (additive protrusion) onto a region's edge.
+ * @param part - the sheet-metal part to modify.
+ * @param spec - tab definition: edge, width, and length.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the tab added, or the first error.
+ */
+export declare function addTab(part: SheetMetalPart, spec: TabSpec): Result<SheetMetalPart>;
+/**
+ * Self-fixturing tab-and-slot joint: a tab on one region + a matching slot on another.
+ * @param part - the sheet-metal part to modify.
+ * @param tab - the tab to add to the first region.
+ * @param slot - placement of the matching slot on the second region.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the joint added, or the first error.
+ */
+export declare function tabAndSlot(part: SheetMetalPart, tab: TabSpec, slot: SlotPlacement): Result<SheetMetalPart>;
+/**
+ * Form a louver (vent flap cut on 3 sides, formed up along the hinge) on a region.
+ * @param part - the sheet-metal part to modify.
+ * @param opts - louver geometry: target `region`, centre `(x, y)`, `length`, `width`, `height`, and optional `direction`.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the louver formed, or the first error.
+ */
+export declare function louver(part: SheetMetalPart, opts: {
+    region: string;
+    x: number;
+    y: number;
+    length: number;
+    width: number;
+    height: number;
+    direction?: 'up' | 'down';
+}): Result<SheetMetalPart>;
+/**
+ * Form a round emboss (raised) or dimple (recessed) on a region.
+ * @param part - the sheet-metal part to modify.
+ * @param opts - emboss geometry: target `region`, centre `(x, y)`, `diameter`, `height`, and `kind` (`dimple` or `emboss`).
+ * @returns a `Result<SheetMetalPart>` carrying the part with the form added, or the first error.
+ */
+export declare function emboss(part: SheetMetalPart, opts: {
+    region: string;
+    x: number;
+    y: number;
+    diameter: number;
+    height: number;
+    kind: 'dimple' | 'emboss';
+}): Result<SheetMetalPart>;
+/**
+ * Author a contour flange: an open line/arc profile swept along a base edge into a
+ * multi-bend cross-section. The development is exact (Σ segment developed lengths).
+ * @param part - the sheet-metal part the flange is added to.
+ * @param spec - contour flange definition: profile, base edge, and bend parameters.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the contour flange added, or the first error.
+ */
+export declare function contourFlange(part: SheetMetalPart, spec: ContourFlangeSpec): Result<SheetMetalPart>;
+/**
+ * Author a lofted / ruled transition flange between two parallel open profiles. The
+ * development is by triangulation — exact for a developable transition, an
+ * approximation (with a `DEVELOPMENT_APPROXIMATE` unfold warning) otherwise.
+ * @param part - the sheet-metal part the flange is added to.
+ * @param spec - lofted flange definition: the two open profiles and their alignment.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the lofted flange added, or the first error.
+ */
+export declare function loftedFlange(part: SheetMetalPart, spec: LoftedFlangeSpec): Result<SheetMetalPart>;
+/**
+ * Author a hem: fold a region edge back ~180°+ onto its parent and run a short
+ * return leg. The development is exact (Σ curl bend allowances + return length).
+ * @param part - the sheet-metal part the hem is added to.
+ * @param spec - hem definition: edge, curl radius, and return leg length.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the hem added, or the first error.
+ */
+export declare function hem(part: SheetMetalPart, spec: HemSpec): Result<SheetMetalPart>;
+/**
+ * Author a jog (joggle): two opposite bends stepping the flat by `offsetHeight`
+ * perpendicular to its plane, then continuing parallel. Development is exact.
+ * @param part - the sheet-metal part the jog is added to.
+ * @param spec - jog definition: bend line, offset height, and radii.
+ * @returns a `Result<SheetMetalPart>` carrying the part with the jog added, or the first error.
+ */
+export declare function jog(part: SheetMetalPart, spec: JogSpec): Result<SheetMetalPart>;
+/**
+ * Emit an annotated multi-layer DXF string for a flat pattern.
+ * @param pattern - the flat pattern to serialize.
+ * @param options - optional DXF output options (layers, precision, units).
+ * @returns a `Result<string>` carrying the DXF text, or the first error.
+ */
+export declare function toDXF(pattern: FlatPattern, options?: DxfOptions): Result<string>;
+/**
+ * Nest developed flat patterns onto stock sheets to reduce waste. The default
+ * `strategy: "bbox"` packs each part as its outline bounding box (fast, no
+ * interlocking). `strategy: "nfp"` is true-shape / no-fit-polygon nesting: the actual
+ * outline polygons are packed so concave (L-shaped) parts interlock for higher
+ * utilization. The NFP packer is a HEURISTIC (bottom-left-fill) — not provably
+ * optimal — but never overlaps parts and never drops a part silently.
+ * @param patterns - the flat patterns to place onto stock sheets.
+ * @param options - nesting configuration: stock sheet size, strategy, and spacing.
+ * @returns a `Result<NestResult>` carrying the placed sheets and part transforms, or the first error.
+ */
+export declare function nest(patterns: FlatPattern[], options: NestOptions): Result<NestResult>;
+/**
+ * Emit one fabrication-ready DXF for a single nested sheet (all parts placed).
+ * @param result - the nesting result containing the sheet to render.
+ * @param patterns - the original flat patterns referenced by `result`.
+ * @param sheetIndex - index of the nested sheet to emit.
+ * @param options - optional DXF output options (layers, precision, units).
+ * @returns a `Result<string>` carrying the DXF text, or the first error.
+ */
+export declare function nestToDXF(result: NestResult, patterns: FlatPattern[], sheetIndex: number, options?: DxfOptions): Result<string>;
+/**
+ * Build a bend report by walking the part's feature tree.
+ * @param part - the sheet-metal part to report on.
+ * @returns a `Result<BendReport>` carrying the computed bend report, or the first error.
+ */
+export declare function report(part: SheetMetalPart): Result<BendReport>;
+/**
+ * Project the report already computed by {@link unfold} without re-walking the tree.
+ * @param result - the unfold result whose bend report is to be projected.
+ * @returns a `Result<BendReport>` carrying the projected bend report, or the first error.
+ */
+export declare function reportFrom(result: UnfoldResult): Result<BendReport>;
+/**
+ * Serialize a bend report to stable pretty-printed JSON.
+ * @param report - the bend report to serialize.
+ * @returns the stable pretty-printed JSON string.
+ */
+export declare function reportJSON(report: BendReport): string;
+/**
+ * Manufacturability checks — advisory warnings, never errors.
+ * @param part - the sheet-metal part to check.
+ * @returns the list of manufacturability warnings (empty when the part is clean).
+ */
+export declare function validate(part: SheetMetalPart): SheetMetalWarning[];
+/**
+ * Bend allowance `BA = (π/180)·|angle|·(R + K·T)` for a single bend.
+ * @param angleDeg - the bend angle in degrees.
+ * @param thickness - the material thickness, in the same units as the rule radii.
+ * @param rule - the bend rule (K-factor, inner radius, or a bend-table reference) to apply.
+ * @param onWarning - optional callback invoked for non-fatal warnings during the computation.
+ * @returns a `Result<number>` carrying the bend allowance, or the first error.
+ */
+export declare function allowance(angleDeg: number, thickness: number, rule: BendRule, onWarning?: (warning: SheetMetalWarning) => void): Result<number>;
+/**
+ * Neutral-axis developed length of a bend region (numerically equal to the allowance).
+ * @param angleDeg - the bend angle in degrees.
+ * @param thickness - the material thickness, in the same units as the rule radii.
+ * @param rule - the bend rule (K-factor, inner radius, or a bend-table reference) to apply.
+ * @param onWarning - optional callback invoked for non-fatal warnings during the computation.
+ * @returns a `Result<number>` carrying the developed length, or the first error.
+ */
+export declare function developed(angleDeg: number, thickness: number, rule: BendRule, onWarning?: (warning: SheetMetalWarning) => void): Result<number>;
+/**
+ * Register (or replace) a shop bend table so rules can reference it by id.
+ * @param table - the bend table to register.
+ * @returns a `Result<BendTable>` carrying the registered table, or the first error.
+ */
+export declare function addBendTable(table: BendTable): Result<BendTable>;
+/**
+ * Look up a registered bend table by id (starter tables included).
+ * @param id - the bend table id to look up.
+ * @returns the matching `BendTable`, or `undefined` when no such table is registered.
+ */
+export declare function bendTable(id: string): BendTable | undefined;
+/**
+ * Resolve a bend's developed allowance through the single resolution point:
+ * a referenced bend table, then an explicit `rule.allowance`, then the K-factor
+ * formula. This is what {@link developed} delegates to.
+ * @param rule - the bend rule (bend-table reference, explicit allowance, or K-factor) to resolve.
+ * @param angleDeg - the bend angle in degrees.
+ * @param thickness - the material thickness, in the same units as the rule radii.
+ * @param onWarning - optional callback invoked for non-fatal warnings during the computation.
+ * @returns a `Result<number>` carrying the resolved allowance, or the first error.
+ */
+export declare function resolveAllowance(rule: BendRule, angleDeg: number, thickness: number, onWarning?: (warning: SheetMetalWarning) => void): Result<number>;
+export type { AuthorSpec, FlangeSpec, MiterPlane, DxfOptions, SlotPlacement, NestOptions, NestResult };
+/** The live bend-table registry (shared resource, §7.3). */
+export { bendTables } from './bendTableFns.js';
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAA4B,KAAK,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAEL,KAAK,UAAU,EACf,KAAK,UAAU,EAChB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,EAGL,KAAK,UAAU,EAChB,MAAM,eAAe,CAAC;AAYvB,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AAMrB,OAAO,EAA0C,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AACtF,OAAO,EAGL,KAAK,WAAW,EAChB,KAAK,UAAU,EAChB,MAAM,cAAc,CAAC;AAQtB,OAAO,EAIL,KAAK,SAAS,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,SAAS,EACT,UAAU,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,OAAO,EACP,YAAY,EACZ,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAE/D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC,CAEjE;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAE3F;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAErF;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,cAAc,EACpB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,GAAG,SAAI,GACN,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,UAAU,GAChB,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAE3F;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,cAAc,EACpB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,UAAU,GAChB,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,CAExF;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,QAAQ,EAAE,MAAM,GACf,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAChG,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GACzB,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,CAElF;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,aAAa,GAClB,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE;IACJ,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CAC3B,GACA,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAAE,GAC1G,MAAM,CAAC,cAAc,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC,cAAc,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC,CAEjG;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,CAE/E;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,CAE/E;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAEhF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAEtF;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,WAAW,EAAE,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,UAAU,GACnB,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,EAAE,CAElE;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAC/C,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAC/C,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAE3D;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAC/C,MAAM,CAAC,MAAM,CAAC,CAEhB;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AAEvG,4DAA4D;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC"}