@cutoptim/engine 1.0.0 → 1.3.0

package/dist/types.gen.d.ts

@@ -503,6 +503,36 @@ export interface Part1D {
     material?: string;
     /** Opaque JSON object (any keys) echoed back VERBATIM on the matching output (a part's meta on every placed piece of it; a stock row's meta on every sheet/rod cut from it). Attach ERP article numbers, order-line ids, customer refs to reconcile the cut plan with your system. Never parsed, never affects placement. Part meta follows its request row: the meta of each row lands on exactly its qty of placed pieces, even when rows share a name; stock meta by stock-row order. */
     meta?: Record<string, unknown>;
+    ends?: MitreEnds;
+    /** Mitre pairing only: which 180° turns of the part on the bar are allowed, so its angled end can meet a neighbour's. `none` (default — a profiled moulding or one-sided stock), `face` (end for end, the crown or top edge stays up — roof members), `edge` (end for end over the edge — flat stock, frames), `any`. */
+    flip?: "none" | "face" | "edge" | "any";
+    /** Mitre pairing only: the side of the bar the `angle` of `ends` is seen on. Required with `ends` (a 1D part has no cross-section to take it from). Unit-agnostic: pick one unit (mm, inch, …) for every length in the request and every length in the response is in that same unit. Nothing is converted server-side. */
+    depth?: number;
+    /** Mitre pairing only: the other side, the one the `bevel` is seen on. Required with `ends`. Unit-agnostic: pick one unit (mm, inch, …) for every length in the request and every length in the response is in that same unit. Nothing is converted server-side. */
+    thickness?: number;
+}
+/** One end cut of a part, in degrees from square (0 = a square end), signed. The part is measured long point to long point (`length` is its overall length). A part whose two end cuts would cross inside its section (shorter than its leads) cannot be made: a 400 `invalid_request` naming `parts[i].ends` says how long it must at least be. */
+export interface EndCut {
+    /** The face angle: the mitre or plumb cut as seen on the `depth` side (wood: on `sh` as entered). */
+    angle: number;
+    /** The edge angle: the bevel as seen on the `thickness` side (wood: on `sw` as entered). A compound cut has both. */
+    bevel?: number;
+}
+/** The angled ends of a part, read only with `options.mitrePairing`. Two parts of one section whose facing ends lie in one plane (after a turn `flip` allows) can be cut with ONE saw cut between them: the triangle between the long and the short point is not wasted. Without `mitrePairing` the ends are not used (a warning says so) and the part packs as its `length`. */
+export interface MitreEnds {
+    start?: EndCut;
+    end?: EndCut;
+}
+/** This part's far end is ONE saw cut shared with the next part on the bar. The next part starts at `pos + length − lead + kerfAlongAxis` computed from the rounded values shown (not one kerf after `pos + length`), and the shared wood is counted once in `yieldPct`. */
+export interface SharedCut {
+    /** Face angle of the cut in degrees, as the part lies on the bar. */
+    angle: number;
+    /** Edge angle of the cut in degrees, as the part lies on the bar (0 = none). */
+    bevel: number;
+    /** The kerf measured along the bar: an angled blade removes more length than its width. Unit-agnostic: pick one unit (mm, inch, …) for every length in the request and every length in the response is in that same unit. Nothing is converted server-side. */
+    kerfAlongAxis: number;
+    /** Distance along the bar between the cut's long point and short point. Unit-agnostic: pick one unit (mm, inch, …) for every length in the request and every length in the response is in that same unit. Nothing is converted server-side. */
+    lead: number;
 }
 export interface Stock1D {
     /** Bar length. Unit-agnostic: pick one unit (mm, inch, …) for every length in the request and every length in the response is in that same unit. Nothing is converted server-side. */
@@ -538,6 +568,8 @@ export interface Options1D {
     respectStock?: boolean;
     /** Output filter: report a leftover only if it is at least this long. */
     minOffcut?: number;
+    /** Pair parts of one section whose facing ends (`parts[].ends`) can share ONE saw cut. Off by default: a request without it is solved exactly as before. On, a plan with pairs is returned only when it ranks strictly better than the unpaired plan by the packer's own ranking (parts placed first, then material — or price with `minimizeCost`); otherwise the unpaired plan comes back. Pairs only, no chains of three or more. */
+    mitrePairing?: boolean;
 }
 export interface Optimize1DRequest {
     parts: Array<Part1D>;
@@ -566,6 +598,10 @@ export interface PartWood {
     material?: string;
     /** Opaque JSON object (any keys) echoed back VERBATIM on the matching output (a part's meta on every placed piece of it; a stock row's meta on every sheet/rod cut from it). Attach ERP article numbers, order-line ids, customer refs to reconcile the cut plan with your system. Never parsed, never affects placement. Part meta follows its request row: the meta of each row lands on exactly its qty of placed pieces, even when rows share a name; stock meta by stock-row order. */
     meta?: Record<string, unknown>;
+    /** Angled ends (mitre pairing). The `angle` is seen on `sh` AS ENTERED and the `bevel` on `sw`, so send the section the way the angles were measured. */
+    ends?: MitreEnds;
+    /** Mitre pairing only: which 180° turns of the part on the bar are allowed, so its angled end can meet a neighbour's. `none` (default — a profiled moulding or one-sided stock), `face` (end for end, the crown or top edge stays up — roof members), `edge` (end for end over the edge — flat stock, frames), `any`. */
+    flip?: "none" | "face" | "edge" | "any";
 }
 export interface StockWood {
     /** Optional stock label, echoed back as `sections[].stockName` so a plan can name the material an operator has to fetch. */
@@ -600,6 +636,8 @@ export interface OptionsWood {
     respectStock?: boolean;
     /** Output filter: report a leftover only if it is at least this long. */
     minOffcut?: number;
+    /** Pair parts of one section whose facing ends (`parts[].ends`) can share ONE saw cut. Off by default: a request without it is solved exactly as before. On, a plan with pairs is returned only when it ranks strictly better than the unpaired plan by the packer's own ranking (parts placed first, then material — or price with `minimizeCost`); otherwise the unpaired plan comes back. Pairs only, no chains of three or more. */
+    mitrePairing?: boolean;
 }
 export interface OptimizeWoodRequest {
     parts: Array<PartWood>;
@@ -625,6 +663,10 @@ export interface CutStep {
     length: number;
     /** 1-based machine pass. Starts at 1 and increments ONLY when the axis flips relative to the parent cut, so ripping a board into six strips is one stage and crosscutting them is the next. This is the panel-saw sense of "3-stage cutting", not tree depth, and it is what `options.maxCutStages` constrains. */
     stage: number;
+    /** 1D/wood with `options.mitrePairing` only: the face angle in degrees of an ANGLED cut, as the part lies on the bar — a shared cut (between a part with `sharedCut` and the next one) or an end of a part with `ends` that no neighbour shares. A part's angled start, or a square start right after an angled end, is a saw pass of its own: a HEAD step at that part's `pos`, before its far step (so `metrics.cuts` can exceed `placed`). A far step's `pos` is the long point of the part it frees (`pos + length`). Absent on every square cut. */
+    angle?: number;
+    /** Comes with `angle`: the edge angle of that cut in degrees (0 = none). */
+    bevel?: number;
 }
 /** A part on a board. `x`/`y` is its top-left corner measured from the top-left corner of the sheet, `x` growing right and `y` growing downward. */
 export interface PlacedPart2D {
@@ -877,6 +919,9 @@ export interface PlacedPart1D {
     length: number;
     /** Opaque JSON object (any keys) echoed back VERBATIM on the matching output (a part's meta on every placed piece of it; a stock row's meta on every sheet/rod cut from it). Attach ERP article numbers, order-line ids, customer refs to reconcile the cut plan with your system. Never parsed, never affects placement. Part meta follows its request row: the meta of each row lands on exactly its qty of placed pieces, even when rows share a name; stock meta by stock-row order. */
     meta?: Record<string, unknown>;
+    sharedCut?: SharedCut;
+    /** Mitre pairing only: the part lies turned on the bar so its end meets its neighbour's — `face` end for end (crown kept up), `edge` end for end over the edge, `roll` rolled about its axis. Absent = as entered. */
+    flipped?: "face" | "edge" | "roll";
 }
 export interface Rod {
     /** FULL bar length as supplied in `stock`. */
@@ -909,6 +954,8 @@ export interface Metrics1D {
     totalPrice: number;
     /** How many pieces fitted only because `options.tolerance` allowed an overshoot. */
     toleranceAcceptedCount: number;
+    /** Present only with `options.mitrePairing`: how many cuts in the plan are shared by two parts (`sharedCut`). */
+    sharedCuts?: number;
 }
 export interface Unplaced1D {
     /** The part name. */
@@ -1028,6 +1075,8 @@ export interface MetricsWood {
     totalPrice: number;
     /** How many pieces fitted only because `options.tolerance` allowed an overshoot. */
     toleranceAcceptedCount: number;
+    /** Present only with `options.mitrePairing`: how many cuts in the plan are shared by two parts (`sharedCut`). */
+    sharedCuts?: number;
 }
 export interface OptimizeWoodResponse {
     engine: "heuristic" | "balanced";

package/dist/types.gen.js

@@ -1,3 +1,3 @@
 // GENERATED by scripts/gen-sdks.ts from the CutOptim Engine API OpenAPI document — DO NOT EDIT.
-// contract 1 · spec sha256 d12a371f3242e7b21df0aa4ecf2df4b2f60f8670bbed7e47bbe3d4cbf08678fb · @cutoptim/engine 1.0.0
+// contract 1 · spec sha256 e29a45d3c07667cf676ceb46a7c24ec3203683e50f72ba25f0677ac4af140c71 · @cutoptim/engine 1.3.0
 export {};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.0.0";
+export declare const VERSION = "1.3.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 // The package version — rewritten by scripts/gen-sdks.ts together with package.json (sent as the User-Agent).
-export const VERSION = '1.0.0';
+export const VERSION = '1.3.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cutoptim/engine",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "Official client for the CutOptim Engine API — cutting optimization (2D panels, 1D linear, timber, true-shape nesting) over HTTPS.",
   "license": "MIT",
   "author": "CutOptim <support@cutoptim.com>",