@constructorfleet/sketchforge-engine 1.26.0 → 1.27.0

package/dist/cadAnalysis.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Interference and wall-thickness analysis over kernel solids (#380).
+ *
+ * Kernel-agnostic on purpose, like `exactBooleanSolids`: the REST API runs it
+ * under Node on solids placed from the stored project, and the editor's CAD
+ * worker runs it in the browser on solids rebuilt from the parts it sends. Both
+ * then give the same answer, refuse the same oversized requests, and disclose
+ * the same method, because there is only one implementation of each.
+ *
+ * Neither function changes anything: they read solids and return numbers.
+ */
+import type { OcctKernel, ShapeHandle } from "occt-wasm";
+export declare const MAX_INTERFERENCE_SHAPES = 128;
+export declare const MAX_INTERFERENCE_CANDIDATES = 512;
+export declare const INTERFERENCE_METHOD: "OCCT exact distance and common volume; AABB candidate prefilter";
+export type InterferencePair = {
+    a: {
+        id: string;
+        name: string;
+    };
+    b: {
+        id: string;
+        name: string;
+    };
+    /** Exact OCCT minimum surface distance in mm. */
+    gap: number;
+    /** Exact common volume in mm^3; zero when separated or touching. */
+    overlapVolume: number;
+    /** Imported triangle meshes remain tessellated inputs to the exact kernel solver. */
+    precision: "exact" | "tessellated";
+};
+export type InterferenceReport = {
+    shapesChecked: number;
+    candidatePairsChecked: number;
+    clearance: number;
+    method: typeof INTERFERENCE_METHOD;
+    pairs: InterferencePair[];
+};
+export type InterferenceRefusal = {
+    reason: "invalid_clearance";
+} | {
+    reason: "too_many_shapes";
+    limit: number;
+    given: number;
+} | {
+    reason: "too_many_candidates";
+    limit: number;
+    given: number;
+};
+export type InterferenceResult = {
+    ok: true;
+    value: InterferenceReport;
+} | {
+    ok: false;
+    refusal: InterferenceRefusal;
+};
+/** One shape to check: who it is, and whether its solid was sewn from triangles. */
+export type InterferenceOperand = {
+    id: string;
+    name: string;
+    tessellated: boolean;
+};
+/** Why a request is refused before any solid is built, or null when it may run. */
+export declare function interferenceRequestRefusal(count: number, clearance: number): InterferenceRefusal | null;
+/**
+ * Exact gaps and overlap volumes between every pair of operands within
+ * `clearance`. Axis-aligned bounds only discard pairs that cannot be that
+ * close; every pair left is measured by OCCT. Exceeding either limit refuses
+ * the request whole -- half a report would read as "nothing else collides".
+ *
+ * `solidFor` builds an operand's solid where it stands in the project.
+ */
+export declare function interferenceBetweenSolids<T extends InterferenceOperand>(cad: OcctKernel, operands: readonly T[], solidFor: (operand: T) => ShapeHandle, clearance?: number): InterferenceResult;
+export declare const WALL_THICKNESS_MAX_FACES = 256;
+export type WallThicknessResult = {
+    minimum: number | null;
+    unit: "mm";
+    method: "sampled-opposing-surface-distance";
+    samplesPerFace: number;
+    facesChecked: number;
+};
+/** Why a solid cannot be sampled at all. */
+export declare class WallThicknessRefusal extends Error {
+    readonly reason: "no_faces" | "too_many_faces";
+    readonly limit?: number | undefined;
+    constructor(reason: "no_faces" | "too_many_faces", limit?: number | undefined);
+}
+/**
+ * The smallest sampled distance between opposing faces of `solid`. This is a
+ * screening estimate, not a medial-axis or certified minimum-thickness result:
+ * a wall thinner between two sample points than at any of them is missed.
+ */
+export declare function sampledWallThickness(cad: OcctKernel, solid: ShapeHandle): WallThicknessResult;
+//# sourceMappingURL=cadAnalysis.d.ts.map

package/dist/cadAnalysis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cadAnalysis.d.ts","sourceRoot":"","sources":["../src/cadAnalysis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAQ,MAAM,WAAW,CAAC;AAE/D,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAC3C,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAC/C,eAAO,MAAM,mBAAmB,EAAG,iEAA0E,CAAC;AAG9G,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,SAAS,EAAE,OAAO,GAAG,aAAa,CAAC;CACpC,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,mBAAmB,CAAC;IACnC,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B,CAAC;AACF,MAAM,MAAM,mBAAmB,GAC3B;IAAE,MAAM,EAAE,mBAAmB,CAAA;CAAE,GAC/B;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,qBAAqB,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,kBAAkB,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEvH,oFAAoF;AACpF,MAAM,MAAM,mBAAmB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,CAAC;AAWrF,mFAAmF;AACnF,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAIvG;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,mBAAmB,EACrE,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,SAAS,CAAC,EAAE,EACtB,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,WAAW,EACrC,SAAS,SAAI,GACZ,kBAAkB,CAiCpB;AAED,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAI5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,mCAAmC,CAAC;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,4CAA4C;AAC5C,qBAAa,oBAAqB,SAAQ,KAAK;IACjC,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,gBAAgB;IAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM;gBAA9D,MAAM,EAAE,UAAU,GAAG,gBAAgB,EAAW,KAAK,CAAC,EAAE,MAAM,YAAA;CAMpF;AAeD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,GAAG,mBAAmB,CA0B7F"}

package/dist/cadAnalysis.js

@@ -0,0 +1,143 @@
+/**
+ * Interference and wall-thickness analysis over kernel solids (#380).
+ *
+ * Kernel-agnostic on purpose, like `exactBooleanSolids`: the REST API runs it
+ * under Node on solids placed from the stored project, and the editor's CAD
+ * worker runs it in the browser on solids rebuilt from the parts it sends. Both
+ * then give the same answer, refuse the same oversized requests, and disclose
+ * the same method, because there is only one implementation of each.
+ *
+ * Neither function changes anything: they read solids and return numbers.
+ */
+export const MAX_INTERFERENCE_SHAPES = 128;
+export const MAX_INTERFERENCE_CANDIDATES = 512;
+export const INTERFERENCE_METHOD = "OCCT exact distance and common volume; AABB candidate prefilter";
+const CONTACT_EPSILON_MM = 1e-7;
+function boundsWithinClearance(a, b, clearance) {
+    const dx = Math.max(0, b.xmin - a.xmax, a.xmin - b.xmax);
+    const dy = Math.max(0, b.ymin - a.ymax, a.ymin - b.ymax);
+    const dz = Math.max(0, b.zmin - a.zmax, a.zmin - b.zmax);
+    return Math.hypot(dx, dy, dz) <= clearance;
+}
+/** Why a request is refused before any solid is built, or null when it may run. */
+export function interferenceRequestRefusal(count, clearance) {
+    if (!Number.isFinite(clearance) || clearance < 0)
+        return { reason: "invalid_clearance" };
+    if (count > MAX_INTERFERENCE_SHAPES)
+        return { reason: "too_many_shapes", limit: MAX_INTERFERENCE_SHAPES, given: count };
+    return null;
+}
+/**
+ * Exact gaps and overlap volumes between every pair of operands within
+ * `clearance`. Axis-aligned bounds only discard pairs that cannot be that
+ * close; every pair left is measured by OCCT. Exceeding either limit refuses
+ * the request whole -- half a report would read as "nothing else collides".
+ *
+ * `solidFor` builds an operand's solid where it stands in the project.
+ */
+export function interferenceBetweenSolids(cad, operands, solidFor, clearance = 0) {
+    const refusal = interferenceRequestRefusal(operands.length, clearance);
+    if (refusal)
+        return { ok: false, refusal };
+    const solids = operands.map(solidFor);
+    const queries = cad.queryBatch(solids);
+    const candidates = [];
+    for (let i = 0; i < operands.length; i += 1)
+        for (let j = i + 1; j < operands.length; j += 1) {
+            const a = queries[i];
+            const b = queries[j];
+            if (a && b && boundsWithinClearance(a.bbox, b.bbox, clearance))
+                candidates.push([i, j]);
+            if (candidates.length > MAX_INTERFERENCE_CANDIDATES) {
+                return { ok: false, refusal: { reason: "too_many_candidates", limit: MAX_INTERFERENCE_CANDIDATES, given: candidates.length } };
+            }
+        }
+    const pairs = [];
+    for (const [i, j] of candidates) {
+        const gap = cad.distanceBetween(solids[i], solids[j]);
+        if (gap > clearance + CONTACT_EPSILON_MM)
+            continue;
+        const overlapVolume = gap <= CONTACT_EPSILON_MM
+            ? Math.max(0, cad.getVolume(cad.common(solids[i], solids[j])))
+            : 0;
+        const a = operands[i];
+        const b = operands[j];
+        pairs.push({
+            a: { id: a.id, name: a.name },
+            b: { id: b.id, name: b.name },
+            gap,
+            overlapVolume,
+            precision: a.tessellated || b.tessellated ? "tessellated" : "exact",
+        });
+    }
+    pairs.sort((a, b) => a.gap - b.gap || b.overlapVolume - a.overlapVolume || a.a.id.localeCompare(b.a.id));
+    return { ok: true, value: { shapesChecked: operands.length, candidatePairsChecked: candidates.length, clearance, method: INTERFERENCE_METHOD, pairs } };
+}
+export const WALL_THICKNESS_MAX_FACES = 256;
+/** Samples per face are a GRID x GRID lattice over the face's parameter range. */
+const WALL_THICKNESS_GRID = 5;
+/** Why a solid cannot be sampled at all. */
+export class WallThicknessRefusal extends Error {
+    reason;
+    limit;
+    constructor(reason, limit) {
+        super(reason === "no_faces"
+            ? "The shape has no faces to analyze."
+            : `Wall-thickness analysis supports at most ${limit} faces.`);
+        this.reason = reason;
+        this.limit = limit;
+        this.name = "WallThicknessRefusal";
+    }
+}
+function faceSamples(cad, face) {
+    const uv = cad.uvBounds(face);
+    const points = [];
+    for (let i = 0; i < WALL_THICKNESS_GRID; i += 1)
+        for (let j = 0; j < WALL_THICKNESS_GRID; j += 1) {
+            const u = uv.uMin + (uv.uMax - uv.uMin) * (i + 0.5) / WALL_THICKNESS_GRID;
+            const v = uv.vMin + (uv.vMax - uv.vMin) * (j + 0.5) / WALL_THICKNESS_GRID;
+            if (cad.classifyPointOnFace(face, u, v) !== "out") {
+                points.push({ point: cad.pointOnSurface(face, u, v), normal: cad.surfaceNormal(face, u, v) });
+            }
+        }
+    return points;
+}
+/**
+ * The smallest sampled distance between opposing faces of `solid`. This is a
+ * screening estimate, not a medial-axis or certified minimum-thickness result:
+ * a wall thinner between two sample points than at any of them is missed.
+ */
+export function sampledWallThickness(cad, solid) {
+    const faces = cad.getSubShapes(solid, "face");
+    if (!faces.length)
+        throw new WallThicknessRefusal("no_faces");
+    if (faces.length > WALL_THICKNESS_MAX_FACES)
+        throw new WallThicknessRefusal("too_many_faces", WALL_THICKNESS_MAX_FACES);
+    const sampled = faces.map((face) => faceSamples(cad, face));
+    let minimum = Infinity;
+    for (let i = 0; i < faces.length; i += 1)
+        for (let j = i + 1; j < faces.length; j += 1) {
+            for (const source of sampled[i]) {
+                for (const target of sampled[j]) {
+                    const dot = source.normal.x * target.normal.x + source.normal.y * target.normal.y + source.normal.z * target.normal.z;
+                    if (dot > -0.5)
+                        continue;
+                    const uv = cad.uvFromPoint(faces[j], source.point);
+                    if (cad.classifyPointOnFace(faces[j], uv.u, uv.v) === "out")
+                        continue;
+                    const projected = cad.pointOnSurface(faces[j], uv.u, uv.v);
+                    const distance = Math.hypot(source.point.x - projected.x, source.point.y - projected.y, source.point.z - projected.z);
+                    if (distance > 1e-7 && distance < minimum)
+                        minimum = distance;
+                }
+            }
+        }
+    return {
+        minimum: Number.isFinite(minimum) ? minimum : null,
+        unit: "mm",
+        method: "sampled-opposing-surface-distance",
+        samplesPerFace: WALL_THICKNESS_GRID * WALL_THICKNESS_GRID,
+        facesChecked: faces.length,
+    };
+}
+//# sourceMappingURL=cadAnalysis.js.map

package/dist/cadAnalysis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cadAnalysis.js","sourceRoot":"","sources":["../src/cadAnalysis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAC3C,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAC;AAC/C,MAAM,CAAC,MAAM,mBAAmB,GAAG,iEAA0E,CAAC;AAC9G,MAAM,kBAAkB,GAAG,IAAI,CAAC;AA8BhC,SAAS,qBAAqB,CAAC,CAAS,EAAE,CAAS,EAAE,SAAiB;IACpE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IACzD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC;AAC7C,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,0BAA0B,CAAC,KAAa,EAAE,SAAiB;IACzE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC;IACzF,IAAI,KAAK,GAAG,uBAAuB;QAAE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,uBAAuB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACxH,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,GAAe,EACf,QAAsB,EACtB,QAAqC,EACrC,SAAS,GAAG,CAAC;IAEb,MAAM,OAAO,GAAG,0BAA0B,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvE,IAAI,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IAE3C,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7F,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,IAAI,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC;gBAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACxF,IAAI,UAAU,CAAC,MAAM,GAAG,2BAA2B,EAAE,CAAC;gBACpD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,qBAAqB,EAAE,KAAK,EAAE,2BAA2B,EAAE,KAAK,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YACjI,CAAC;QACH,CAAC;IAED,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAE,EAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC;QACxD,IAAI,GAAG,GAAG,SAAS,GAAG,kBAAkB;YAAE,SAAS;QACnD,MAAM,aAAa,GAAG,GAAG,IAAI,kBAAkB;YAC7C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,EAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC,CAAC;QACN,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;QAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC;YACT,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;YAC7B,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;YAC7B,GAAG;YACH,aAAa;YACb,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO;SACpE,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,KAAK,EAAE,EAAE,CAAC;AAC1J,CAAC;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAC5C,kFAAkF;AAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAU9B,4CAA4C;AAC5C,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IACxB;IAAgD;IAArE,YAAqB,MAAqC,EAAW,KAAc;QACjF,KAAK,CAAC,MAAM,KAAK,UAAU;YACzB,CAAC,CAAC,oCAAoC;YACtC,CAAC,CAAC,4CAA4C,KAAK,SAAS,CAAC,CAAC;QAH7C,WAAM,GAAN,MAAM,CAA+B;QAAW,UAAK,GAAL,KAAK,CAAS;QAIjF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,SAAS,WAAW,CAAC,GAAe,EAAE,IAAiB;IACrD,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAyC,EAAE,CAAC;IACxD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,EAAE,CAAC,IAAI,CAAC;QAAE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACjG,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,mBAAmB,CAAC;YAC1E,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,mBAAmB,CAAC;YAC1E,IAAI,GAAG,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;gBAClD,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAe,EAAE,KAAkB;IACtE,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,MAAM,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC9D,IAAI,KAAK,CAAC,MAAM,GAAG,wBAAwB;QAAE,MAAM,IAAI,oBAAoB,CAAC,gBAAgB,EAAE,wBAAwB,CAAC,CAAC;IACxH,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5D,IAAI,OAAO,GAAG,QAAQ,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACvF,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,CAAC,CAAE,EAAE,CAAC;gBACjC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,CAAC,CAAE,EAAE,CAAC;oBACjC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;oBACtH,IAAI,GAAG,GAAG,CAAC,GAAG;wBAAE,SAAS;oBACzB,MAAM,EAAE,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;oBACpD,IAAI,GAAG,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK;wBAAE,SAAS;oBACvE,MAAM,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;oBACtH,IAAI,QAAQ,GAAG,IAAI,IAAI,QAAQ,GAAG,OAAO;wBAAE,OAAO,GAAG,QAAQ,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;QAClD,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,mCAAmC;QAC3C,cAAc,EAAE,mBAAmB,GAAG,mBAAmB;QACzD,YAAY,EAAE,KAAK,CAAC,MAAM;KAC3B,CAAC;AACJ,CAAC"}

package/dist/cadShell.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Hollowing a solid with a wall of a given thickness, on any OCCT kernel.
+ *
+ * The REST endpoint (`serverCadShell.ts`) and the editor's CAD worker both
+ * hollow through this module, so a part shelled in the browser and the same
+ * part shelled over the API come out of the same code at the same tolerance.
+ * It imports nothing Node-only: the caller hands it a kernel and a solid.
+ *
+ * OCCT does the work with `BRepOffsetAPI_MakeThickSolid`, which the bundled
+ * kernel exposes as `shell`. Two things about it are worth knowing before
+ * changing any of this, both found by measuring rather than by reading:
+ *
+ *  - With no faces removed it does not hollow anything. It returns the *inner*
+ *    solid -- the original offset inwards by the thickness -- so a sealed
+ *    hollow has to be the original cut by that, which is what `hollowedSolid`
+ *    does. Asking it to hollow a closed solid directly gives you back a
+ *    smaller solid part, which looks plausible and is not what was asked for.
+ *  - A thickness that does not fit does not reliably fail. Past half the
+ *    part it variously returns an empty compound, a solid that reports
+ *    `isValid: false` with a correct bounding box, or the original solid
+ *    untouched with every extent and the validity flag intact. Only the volume
+ *    tells those apart from a real answer, which is why `hollowedSolid`
+ *    measures it rather than trusting the call to throw.
+ *
+ * Refusals are `CadShellError`s carrying a `reason`, so the REST path can
+ * answer with its English message and status while the editor says the same
+ * thing in the person's language.
+ */
+import type { OcctKernel, ShapeHandle, Vec3 } from "occt-wasm";
+/**
+ * Names for the faces a request is likely to want open, by where they point.
+ *
+ * A caller that knows the geometry can name face indexes from the listing, but
+ * nobody wants to list a box's faces to find out which one is the lid. The
+ * directions are the solid's own axes: +Y up, +Z towards the viewer. Which of
+ * several parallel faces a name means is settled by how far out each sits, so
+ * the solid may stand anywhere.
+ */
+declare const FACE_DIRECTIONS: {
+    readonly top: {
+        readonly x: 0;
+        readonly y: 1;
+        readonly z: 0;
+    };
+    readonly bottom: {
+        readonly x: 0;
+        readonly y: -1;
+        readonly z: 0;
+    };
+    readonly right: {
+        readonly x: 1;
+        readonly y: 0;
+        readonly z: 0;
+    };
+    readonly left: {
+        readonly x: -1;
+        readonly y: 0;
+        readonly z: 0;
+    };
+    readonly front: {
+        readonly x: 0;
+        readonly y: 0;
+        readonly z: 1;
+    };
+    readonly back: {
+        readonly x: 0;
+        readonly y: 0;
+        readonly z: -1;
+    };
+};
+export type FaceDirection = keyof typeof FACE_DIRECTIONS;
+export declare const FACE_DIRECTION_NAMES: FaceDirection[];
+/** What a shell request can be refused for, independent of how it is said. */
+export type CadShellRefusal = "thickness" | "no-volume" | "no-faces" | "face-index" | "direction" | "no-flat-face" | "every-face-open" | "too-thick" | "cannot-offset";
+export declare class CadShellError extends Error {
+    readonly reason: CadShellRefusal;
+    /** The HTTP status the REST path answers with. */
+    readonly status: number;
+    constructor(reason: CadShellRefusal, message: string, status?: number);
+}
+export type CadShellFace = {
+    index: number;
+    /** As OCCT names the underlying surface: `plane`, `cylinder`, `bspline`... */
+    surfaceType: string;
+    area: number;
+    /** Area-weighted centre of the face, which is a real point on a curved one. */
+    centroid: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** The outward normal, or null for a surface that cannot report one. */
+    normal: {
+        x: number;
+        y: number;
+        z: number;
+    } | null;
+    /**
+     * The direction name this face answers to, when it is the outermost flat face
+     * pointing that way. A cavity floor points up as surely as a lid does, so a
+     * face only takes a name if nothing it is parallel to sits further out.
+     */
+    facing: FaceDirection | null;
+};
+export type CadShellRequest = {
+    /** Wall thickness in mm, measured inwards from the surface. */
+    thickness: number;
+    /** Faces to leave open, as direction names or face indexes. */
+    openFaces?: ReadonlyArray<number | string>;
+};
+/**
+ * The normal pointing out of the solid at the middle of a face.
+ *
+ * Exported because the measurement endpoint needs the same normal to answer
+ * "what is the angle between these two faces", and a second copy of this would
+ * be free to drift from the one the face listing and the shell request agree on.
+ */
+export declare function faceOutwardNormal(cad: OcctKernel, face: ShapeHandle): Vec3 | null;
+/** A solid's faces in kernel order, with the direction each one answers to. */
+export declare function describeShellFaces(cad: OcctKernel, solid: ShapeHandle): CadShellFace[];
+/**
+ * The face indexes a request's `openFaces` names, in listing order.
+ *
+ * Mixed on purpose: `["top"]` is what a script asking for a tray wants to write,
+ * and an index from the listing is the only way to name a face that no direction
+ * describes -- one wall of a hexagonal pot, say.
+ */
+export declare function resolveShellOpenFaces(requested: ReadonlyArray<number | string>, faces: ReadonlyArray<Pick<CadShellFace, "index" | "facing">>): number[];
+export declare function shellVolumeOf(cad: OcctKernel, shape: ShapeHandle): number | null;
+/**
+ * Hollow `solid` out to a wall of `request.thickness`, leaving `openFaces` off.
+ *
+ * `faces` is the listing the request's indexes refer to; it is described from
+ * the solid when not given. Returns the hollow and the volumes either side of
+ * it, or throws a `CadShellError`.
+ */
+export declare function shellSolid(cad: OcctKernel, solid: ShapeHandle, request: CadShellRequest, faces?: CadShellFace[]): {
+    solid: ShapeHandle;
+    volume: number;
+    sourceVolume: number;
+};
+export {};
+//# sourceMappingURL=cadShell.d.ts.map

package/dist/cadShell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cadShell.d.ts","sourceRoot":"","sources":["../src/cadShell.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAe/D;;;;;;;;GAQG;AACH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOoB,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,eAAe,CAAC;AAEzD,eAAO,MAAM,oBAAoB,EAAmC,aAAa,EAAE,CAAC;AAEpF,8EAA8E;AAC9E,MAAM,MAAM,eAAe,GACvB,WAAW,GACX,WAAW,GACX,UAAU,GACV,YAAY,GACZ,WAAW,GACX,cAAc,GACd,iBAAiB,GACjB,WAAW,GACX,eAAe,CAAC;AAEpB,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,kDAAkD;IAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAM;CAMnE;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,QAAQ,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,wEAAwE;IACxE,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACnD;;;;OAIG;IACH,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,eAanE;AAiBD,+EAA+E;AAC/E,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,GAAG,YAAY,EAAE,CA0CtF;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC,YA6B5I;AAQD,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,iBAOhE;AA+FD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,KAAK,iBAAiC;;;;EAoB/H"}