@snaptrude/plugin-core 0.9.3 → 0.9.5

package/dist/api/core/io/underlay/index.d.ts

@@ -63,6 +63,54 @@ export declare abstract class PluginCoreIoUnderlayApi {
      * ```
      */
     abstract getBounds(underlay: UnderlayHandle): PluginApiReturn<BBoxComponents | null>;
+    /**
+     * List the distinct original AutoCAD layer names retained by a placed CAD
+     * underlay. Returns `[]` for non-CAD underlays, legacy imports created before
+     * source-layer retention, missing underlays, or CAD drawings without layer tags.
+     *
+     * @param underlay - The placed CAD underlay to inspect.
+     * @returns the retained AutoCAD layer names in first-appearance order.
+     *
+     * @examplePrompt List the original AutoCAD layers in this imported drawing
+     * @examplePrompt Which CAD layers are available in this underlay?
+     *
+     * # Example
+     * ```ts
+     * const layers = await snaptrude.core.io.underlay.listCadLayers(cad)
+     * console.log(layers)
+     * ```
+     */
+    abstract listCadLayers(underlay: UnderlayHandle): PluginApiReturn<string[]>;
+    /**
+     * Read one original AutoCAD layer's retained line and arc geometry in
+     * **Snaptrude world space** and Snaptrude internal units. Results are paged so
+     * large drawings can be inspected without returning the whole DWG at once.
+     *
+     * The world-space coordinates include the CAD underlay's current position,
+     * rotation, scale, and storey elevation. `null` means the underlay no longer
+     * resolves. An unknown layer returns a page with `total: 0`.
+     *
+     * @param underlay - The placed CAD underlay to inspect.
+     * @param layer - Exact, case-sensitive original AutoCAD layer name.
+     * @param options - Optional zero-based offset and page limit (default 500,
+     *   maximum 1000).
+     * @returns a page of retained CAD curves, or `null` if the underlay is gone.
+     * @throws if the handle resolves to an image/PDF rather than a CAD underlay.
+     *
+     * @examplePrompt Read the wall geometry from the A-WALL layer in this CAD underlay
+     * @examplePrompt Get the next 500 curves from the structural CAD layer
+     *
+     * # Example
+     * ```ts
+     * const page = await snaptrude.core.io.underlay.getCadLayerGeometry(
+     *   cad,
+     *   "A-WALL",
+     *   { offset: 0, limit: 500 },
+     * )
+     * if (page) console.log(`${page.curves.length} of ${page.total} curves`)
+     * ```
+     */
+    abstract getCadLayerGeometry(underlay: UnderlayHandle, layer: string, options?: PluginCadLayerGeometryOptions): PluginApiReturn<PluginCadLayerGeometryPage | null>;
     /**
      * Read an underlay's scale. Works for **image and PDF** underlays. Returns
      * `null` for CAD (scaling not supported) or if the handle no longer resolves.
@@ -213,6 +261,96 @@ export declare abstract class PluginCoreIoUnderlayApi {
      * ```
      */
     abstract delete(underlay: UnderlayHandle): PluginApiReturn<void>;
+    /**
+     * Extract **continuous wall centrelines** from one retained AutoCAD layer's
+     * double-line wall faces — the deterministic tracing primitive behind
+     * CAD-to-BIM wall conversion. Instead of paging raw curves and re-deriving
+     * the geometry in worker code, this reads the whole layer and runs the vetted
+     * pipeline: cull fragments, dedupe, merge collinear runs into *faces*, pair
+     * parallel faces a wall-thickness apart into centrelines (midline = axis,
+     * separation = thickness), bridge collinear gaps up to
+     * `bridgeOpenings.maxWidth` into ONE continuous centreline while recording
+     * each bridged span as an opening, then snap near-touching endpoints at
+     * junctions.
+     *
+     * CAD drafters interrupt wall faces at every door/window, so raw wall layers
+     * always have gaps; Snaptrude doors/windows must host into a continuous wall.
+     * The returned centrelines are ready for `design.create.walls`, and each
+     * centreline's `openings` records where the CAD had a gap — feed those to the
+     * door/window placement step. `unpaired` faces (no parallel partner at wall
+     * thickness) are evidence, not noise: a run of unpaired perimeter faces
+     * usually means that stretch of facade is glazed, not solid.
+     *
+     * All lengths are in **Snaptrude internal units** (convert from project units
+     * with `core.units.convert`). Coordinates are world-space plan (x, z).
+     *
+     * Thin parallel pairs (glass lines, mullion faces) are the same algorithm at
+     * a smaller separation: pass e.g. `thicknessRange: [0.01, 0.25]` with
+     * `bridgeOpenings: null` to detect glazing runs on a glazing layer.
+     *
+     * @param underlay - The placed CAD underlay to read.
+     * @param layer - Exact, case-sensitive original AutoCAD layer name.
+     * @param options - Tolerances; see {@linkcode PluginCadCenterlineOptions}.
+     * @returns centrelines + unpaired faces + stats, or `null` if the underlay is gone.
+     * @throws if the handle resolves to an image/PDF rather than a CAD underlay.
+     *
+     * @examplePrompt Trace the walls from the a-wall CAD layer
+     * @examplePrompt Convert the AutoCAD wall linework into Snaptrude walls
+     * @examplePrompt Extract wall centrelines with thickness from the imported DWG
+     * @examplePrompt Find the glazing runs on the a-glazing layer
+     *
+     * # Example
+     * ```ts
+     * const [cad] = await snaptrude.core.io.underlay.list()
+     * const r = await snaptrude.core.io.underlay.extractCenterlines(cad, "a-wall")
+     * if (r) {
+     *   const items = r.centerlines.map((c) => ({
+     *     profile: [c.start, c.end],
+     *     thickness: c.thickness,
+     *   }))
+     *   console.log(`${items.length} walls, ${r.unpaired.length} unpaired faces`)
+     * }
+     * ```
+     */
+    abstract extractCenterlines(underlay: UnderlayHandle, layer: string, options?: PluginCadCenterlineOptions): PluginApiReturn<PluginCadCenterlinesResult | null>;
+    /**
+     * Classify one retained AutoCAD layer's **arcs as door swings** — the
+     * deterministic tracing primitive behind CAD-to-BIM door placement. A door
+     * swing is drawn as a ~90° arc whose radius IS the leaf width and whose
+     * centre IS the hinge point. This filters the layer's arcs by plausible
+     * radius and sweep (rejecting inch-scale fillets, full-circle symbols and
+     * long shallow curves), reads each survivor as a door candidate (hinge, leaf
+     * width, swing direction, hosting wall direction), merges mirrored pairs
+     * sharing a chord line into double doors, and returns a radius histogram —
+     * real drawings use a handful of standard door sizes, so the histogram's
+     * clusters are the drawing's door widths (sanity-check them against the
+     * catalog; distrust arcs in no cluster).
+     *
+     * All lengths are in **Snaptrude internal units**. `rejected` lists filtered
+     * arcs with reasons so nothing is silently dropped.
+     *
+     * @param underlay - The placed CAD underlay to read.
+     * @param layer - Exact, case-sensitive original AutoCAD layer name.
+     * @param options - Gates and binning; see {@linkcode PluginCadArcClassifyOptions}.
+     * @returns door candidates + rejected arcs + histogram, or `null` if the underlay is gone.
+     * @throws if the handle resolves to an image/PDF rather than a CAD underlay.
+     *
+     * @examplePrompt Find the doors on the a-door CAD layer
+     * @examplePrompt Classify the door swing arcs in the imported drawing
+     * @examplePrompt What door sizes does this DWG use?
+     * @examplePrompt Read hinge points and leaf widths from the CAD door layer
+     *
+     * # Example
+     * ```ts
+     * const [cad] = await snaptrude.core.io.underlay.list()
+     * const r = await snaptrude.core.io.underlay.classifyArcs(cad, "a-door")
+     * if (r) {
+     *   console.log(`${r.doors.length} doors; sizes:`,
+     *     r.radiusHistogram.filter((b) => b.count > 1))
+     * }
+     * ```
+     */
+    abstract classifyArcs(underlay: UnderlayHandle, layer: string, options?: PluginCadArcClassifyOptions): PluginApiReturn<PluginCadArcClassifyResult | null>;
 }
 /**
  * Arguments for {@link PluginCoreIoUnderlayApi.list}.
@@ -283,4 +421,385 @@ export declare const PluginUnderlayRefArgs: z.ZodObject<{
     underlay: z.ZodPipe<z.ZodString, z.ZodTransform<UnderlayHandle, string>>;
 }, z.core.$strip>;
 export type PluginUnderlayRefArgs = z.infer<typeof PluginUnderlayRefArgs>;
+/** A retained AutoCAD line represented as a world-space read record. */
+export declare const PluginCadLineGeometry: z.ZodObject<{
+    type: z.ZodLiteral<"line">;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginCadLineGeometry = z.infer<typeof PluginCadLineGeometry>;
+/** A retained AutoCAD arc represented as a world-space read record. */
+export declare const PluginCadArcGeometry: z.ZodObject<{
+    type: z.ZodLiteral<"arc">;
+    centre: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    axis: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginCadArcGeometry = z.infer<typeof PluginCadArcGeometry>;
+/** Line or arc geometry returned by `getCadLayerGeometry`. */
+export declare const PluginCadGeometry: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"line">;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"arc">;
+    centre: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    axis: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type PluginCadGeometry = z.infer<typeof PluginCadGeometry>;
+/** Pagination options for `getCadLayerGeometry`. */
+export declare const PluginCadLayerGeometryOptions: z.ZodObject<{
+    offset: z.ZodDefault<z.ZodNumber>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginCadLayerGeometryOptions = z.input<typeof PluginCadLayerGeometryOptions>;
+/** Arguments for {@link PluginCoreIoUnderlayApi.getCadLayerGeometry}. */
+export declare const PluginCadLayerGeometryArgs: z.ZodObject<{
+    underlay: z.ZodPipe<z.ZodString, z.ZodTransform<UnderlayHandle, string>>;
+    layer: z.ZodString;
+    options: z.ZodDefault<z.ZodObject<{
+        offset: z.ZodDefault<z.ZodNumber>;
+        limit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCadLayerGeometryArgs = z.infer<typeof PluginCadLayerGeometryArgs>;
+/** A page of one original AutoCAD layer's geometry in Snaptrude world space. */
+export declare const PluginCadLayerGeometryPage: z.ZodObject<{
+    layer: z.ZodString;
+    coordinateSpace: z.ZodLiteral<"snaptrude-world">;
+    units: z.ZodLiteral<"snaptrude-internal">;
+    total: z.ZodNumber;
+    offset: z.ZodNumber;
+    curves: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"line">;
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"arc">;
+        centre: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        axis: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">>;
+}, z.core.$strip>;
+export type PluginCadLayerGeometryPage = z.infer<typeof PluginCadLayerGeometryPage>;
+/** A point in the world-space plan (x, z) projection, Snaptrude internal units. */
+export declare const PluginPlanPoint: z.ZodObject<{
+    x: z.ZodNumber;
+    z: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginPlanPoint = z.infer<typeof PluginPlanPoint>;
+/**
+ * Options for {@link PluginCoreIoUnderlayApi.extractCenterlines}. All lengths in
+ * Snaptrude internal units.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `thicknessRange` | `[number, number]`? | Plausible wall thickness `[min, max]` (default `[0.3, 1.6]` ≈ 3–16 in) |
+ * | `mergeGap` | `number`? | Noise tolerance joining collinear segments that are really one face (default `0.05`) |
+ * | `minLength` | `number`? | Cull fragments shorter than this (default `0.1`) |
+ * | `parallelTolDeg` | `number`? | Max angle in degrees between faces still considered parallel (default `2`) |
+ * | `minOverlap` | `number`? | Fraction of the shorter face that must overlap its pair (default `0.6`) |
+ * | `bridgeOpenings` | `{ maxWidth }` \| `null`? | Close collinear centreline gaps up to `maxWidth`, recording each as an opening (default `{ maxWidth: 9.6 }` ≈ 8 ft); `null` disables bridging |
+ */
+export declare const PluginCadCenterlineOptions: z.ZodObject<{
+    thicknessRange: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    mergeGap: z.ZodDefault<z.ZodNumber>;
+    minLength: z.ZodDefault<z.ZodNumber>;
+    parallelTolDeg: z.ZodDefault<z.ZodNumber>;
+    minOverlap: z.ZodDefault<z.ZodNumber>;
+    bridgeOpenings: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        maxWidth: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PluginCadCenterlineOptions = z.input<typeof PluginCadCenterlineOptions>;
+/** Arguments for {@link PluginCoreIoUnderlayApi.extractCenterlines}. */
+export declare const PluginCadCenterlinesArgs: z.ZodObject<{
+    underlay: z.ZodPipe<z.ZodString, z.ZodTransform<UnderlayHandle, string>>;
+    layer: z.ZodString;
+    options: z.ZodDefault<z.ZodObject<{
+        thicknessRange: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        mergeGap: z.ZodDefault<z.ZodNumber>;
+        minLength: z.ZodDefault<z.ZodNumber>;
+        parallelTolDeg: z.ZodDefault<z.ZodNumber>;
+        minOverlap: z.ZodDefault<z.ZodNumber>;
+        bridgeOpenings: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            maxWidth: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCadCenterlinesArgs = z.infer<typeof PluginCadCenterlinesArgs>;
+/** A span bridged over a CAD gap in a continuous centreline — a door/window opening candidate. */
+export declare const PluginCadOpening: z.ZodObject<{
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    width: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginCadOpening = z.infer<typeof PluginCadOpening>;
+/**
+ * One continuous wall centreline extracted from CAD wall faces. `thickness` is
+ * the measured face separation; `openings` are the CAD gaps bridged into this
+ * centreline (feed the door/window step).
+ */
+export declare const PluginCadCenterline: z.ZodObject<{
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    thickness: z.ZodNumber;
+    length: z.ZodNumber;
+    sourceFaceCount: z.ZodNumber;
+    openings: z.ZodArray<z.ZodObject<{
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        width: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCadCenterline = z.infer<typeof PluginCadCenterline>;
+/** A merged face with no parallel partner at wall thickness — evidence (often glazing), not noise. */
+export declare const PluginCadUnpairedFace: z.ZodObject<{
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    length: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginCadUnpairedFace = z.infer<typeof PluginCadUnpairedFace>;
+/** Result of {@link PluginCoreIoUnderlayApi.extractCenterlines}. */
+export declare const PluginCadCenterlinesResult: z.ZodObject<{
+    layer: z.ZodString;
+    coordinateSpace: z.ZodLiteral<"snaptrude-world">;
+    units: z.ZodLiteral<"snaptrude-internal">;
+    centerlines: z.ZodArray<z.ZodObject<{
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        thickness: z.ZodNumber;
+        length: z.ZodNumber;
+        sourceFaceCount: z.ZodNumber;
+        openings: z.ZodArray<z.ZodObject<{
+            start: z.ZodObject<{
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            end: z.ZodObject<{
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            width: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    unpaired: z.ZodArray<z.ZodObject<{
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        length: z.ZodNumber;
+    }, z.core.$strip>>;
+    stats: z.ZodObject<{
+        curvesRead: z.ZodNumber;
+        arcsSkipped: z.ZodNumber;
+        fragmentsCulled: z.ZodNumber;
+        duplicates: z.ZodNumber;
+        faces: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginCadCenterlinesResult = z.infer<typeof PluginCadCenterlinesResult>;
+/**
+ * Options for {@link PluginCoreIoUnderlayApi.classifyArcs}. Lengths in Snaptrude
+ * internal units, sweeps in degrees.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `radiusRange` | `[number, number]`? | Plausible door-leaf widths (default `[3, 5.4]` ≈ 2.5–4.5 ft) |
+ * | `sweepRangeDeg` | `[number, number]`? | Accepted arc sweep in degrees (default `[60, 120]`; a swing is ~90°) |
+ * | `clusterTol` | `number`? | Radius bin size for the histogram (default `0.1`) |
+ */
+export declare const PluginCadArcClassifyOptions: z.ZodObject<{
+    radiusRange: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    sweepRangeDeg: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    clusterTol: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginCadArcClassifyOptions = z.input<typeof PluginCadArcClassifyOptions>;
+/** Arguments for {@link PluginCoreIoUnderlayApi.classifyArcs}. */
+export declare const PluginCadArcClassifyArgs: z.ZodObject<{
+    underlay: z.ZodPipe<z.ZodString, z.ZodTransform<UnderlayHandle, string>>;
+    layer: z.ZodString;
+    options: z.ZodDefault<z.ZodObject<{
+        radiusRange: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        sweepRangeDeg: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        clusterTol: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCadArcClassifyArgs = z.infer<typeof PluginCadArcClassifyArgs>;
+/**
+ * One door candidate read from a CAD swing arc. `hinge` is the arc centre,
+ * `leafWidth` the arc radius, `swingDir` the unit direction from hinge toward
+ * the open leaf, `wallDir` the unit direction of the hosting wall (hinge →
+ * closed-leaf chord end). `openingWidth` equals `leafWidth` for singles and
+ * `2 × leafWidth` for doubles.
+ */
+export declare const PluginCadDoorCandidate: z.ZodObject<{
+    hinge: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    leafWidth: z.ZodNumber;
+    swingDir: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    wallDir: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    openingWidth: z.ZodNumber;
+    double: z.ZodBoolean;
+}, z.core.$strip>;
+export type PluginCadDoorCandidate = z.infer<typeof PluginCadDoorCandidate>;
+/** Result of {@link PluginCoreIoUnderlayApi.classifyArcs}. */
+export declare const PluginCadArcClassifyResult: z.ZodObject<{
+    layer: z.ZodString;
+    coordinateSpace: z.ZodLiteral<"snaptrude-world">;
+    units: z.ZodLiteral<"snaptrude-internal">;
+    doors: z.ZodArray<z.ZodObject<{
+        hinge: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        leafWidth: z.ZodNumber;
+        swingDir: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        wallDir: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        openingWidth: z.ZodNumber;
+        double: z.ZodBoolean;
+    }, z.core.$strip>>;
+    rejected: z.ZodArray<z.ZodObject<{
+        centre: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        radius: z.ZodNumber;
+        sweepDeg: z.ZodNumber;
+        reason: z.ZodString;
+    }, z.core.$strip>>;
+    radiusHistogram: z.ZodArray<z.ZodObject<{
+        radius: z.ZodNumber;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+    stats: z.ZodObject<{
+        curvesRead: z.ZodNumber;
+        arcsConsidered: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginCadArcClassifyResult = z.infer<typeof PluginCadArcClassifyResult>;
 //# sourceMappingURL=index.d.ts.map

package/dist/api/core/io/underlay/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/io/underlay/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,uBAAuB;;IAG3C;;;;;;;;;;;;;;;;OAgBG;aACa,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC,cAAc,EAAE,CAAC;IAExE;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAE3F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,QAAQ,CACtB,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,kBAAkB,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,QAAQ,CACtB,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GACnC,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAE3C;;;;;;;;;;;;;;;;;OAiBG;aACa,UAAU,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAE9F;;;;;;;;;;;;;;OAcG;aACa,UAAU,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;OAmBG;aACa,UAAU,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC;IAE5F;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC;CACxE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,6GAA6G;AAC7G,eAAO,MAAM,2BAA2B;;mBAGtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAErF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/io/underlay/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EACL,cAAc,EACd,cAAc,EAEf,MAAM,qBAAqB,CAAA;AAE5B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,uBAAuB;;IAG3C;;;;;;;;;;;;;;;;OAgBG;aACa,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC,cAAc,EAAE,CAAC;IAExE;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CACvB,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzC;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,CAC3B,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC,MAAM,EAAE,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,mBAAmB,CACjC,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,6BAA6B,GACtC,eAAe,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,QAAQ,CACtB,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,kBAAkB,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,QAAQ,CACtB,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GACnC,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAE3C;;;;;;;;;;;;;;;;;OAiBG;aACa,UAAU,CACxB,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAE3C;;;;;;;;;;;;;;OAcG;aACa,UAAU,CACxB,QAAQ,EAAE,cAAc,GACvB,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;aACa,UAAU,CACxB,QAAQ,EAAE,cAAc,EACxB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,IAAI,CAAC;IAExB;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC;IAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,kBAAkB,CAChC,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,0BAA0B,GACnC,eAAe,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;aACa,YAAY,CAC1B,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,2BAA2B,GACpC,eAAe,CAAC,0BAA0B,GAAG,IAAI,CAAC;CACtD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,6GAA6G;AAC7G,eAAO,MAAM,2BAA2B;;mBAGtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,wEAAwE;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,uEAAuE;AACvE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;iBAM/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,8DAA8D;AAC9D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAG5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,oDAAoD;AACpD,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,0BAA0B;;;;;;;iBAIrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAOrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAGD,mFAAmF;AACnF,eAAO,MAAM,eAAe;;;iBAA6C,CAAA;AACzE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAYrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;iBAWnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kGAAkG;AAClG,eAAO,MAAM,gBAAgB;;;;;;;;;;iBAI3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;iBAO9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE,sGAAsG;AACtG,eAAO,MAAM,qBAAqB;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,oEAAoE;AACpE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAarC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B;;;;iBAQtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,kEAAkE;AAClE,eAAO,MAAM,wBAAwB;;;;;;;;iBAQnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;iBAOjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,8DAA8D;AAC9D,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoBrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA"}

package/dist/api/design/query/index.d.ts

@@ -1148,7 +1148,134 @@ export declare abstract class PluginDesignQueryApi {
      * ```
      */
     abstract getBoundingBox(components: ComponentHandle[]): PluginApiReturn<BBoxComponents | null>;
+    /**
+     * Compute the plan **outline of what is built on a storey** — the union of
+     * the storey's wall (by default) footprints as polygons-with-holes. This is
+     * the footprint-from-the-built-model query: by the time slabs are needed the
+     * walls exist, and the engine's own solids (snapped, joined and mitred at
+     * creation) are the cleanest wall network available — no CAD re-tracing.
+     *
+     * Semantics: the union of wall solids is the wall *material* — a ring-shaped
+     * polygon. The **outer ring is the OUTSIDE wall face** (the slab boundary);
+     * every enclosed region — rooms AND courtyards — appears as a hole. When the
+     * largest hole is ~zero the walls don't enclose anything: the footprint
+     * reports `enclosed: false` (an open wall network), never a garbage outline.
+     * Detached buildings come back as separate footprints.
+     *
+     * A read — nothing is created. Feed a footprint's `outline` to
+     * `core.geom.create.profileFromLinePoints` → `design.create.slab` to build
+     * the floor/roof plate. Coordinates are world-space plan (x, z) in Snaptrude
+     * internal units; `areaSq` values are in squared internal units.
+     *
+     * @param options - storey / included kinds / debris filter; see
+     *   {@linkcode PluginStoreyOutlineOptions}.
+     * @returns the storey's footprints (possibly several for detached buildings)
+     *   plus pieces discarded by `minArea` (`footprints: []` when nothing matches).
+     *
+     * @examplePrompt What is the building footprint on the ground floor?
+     * @examplePrompt Create a floor slab covering the whole storey
+     * @examplePrompt Get the outline of the walls on storey 1
+     * @examplePrompt How much area do the ground-floor walls enclose?
+     *
+     * # Example
+     * ```ts
+     * const r = await snaptrude.design.query.storeyOutline({ storey: 1 })
+     * const main = r.footprints.find((f) => f.enclosed)
+     * if (main) {
+     *   const profile = await snaptrude.core.geom.create.profileFromLinePoints(
+     *     main.outline.map((p) => ({ x: p.x, y: 0, z: p.z })),
+     *   )
+     *   // → design.create.slab with the profile's contour
+     * }
+     * ```
+     */
+    abstract storeyOutline(options?: PluginStoreyOutlineOptions): PluginApiReturn<PluginStoreyOutlineResult>;
 }
+/** A point in the world-space plan (x, z) projection, Snaptrude internal units. */
+export declare const PluginOutlinePlanPoint: z.ZodObject<{
+    x: z.ZodNumber;
+    z: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginOutlinePlanPoint = z.infer<typeof PluginOutlinePlanPoint>;
+/**
+ * Options for {@link PluginDesignQueryApi.storeyOutline}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storey` | `number`? | Only components on this storey (default: all storeys) |
+ * | `include` | {@link PluginEntityType}`[]`? | Component kinds to union (default `["wall"]`) |
+ * | `minArea` | `number`? | Drop union pieces below this plan area, squared internal units (default `1`) |
+ */
+export declare const PluginStoreyOutlineOptions: z.ZodObject<{
+    storey: z.ZodOptional<z.ZodNumber>;
+    include: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        mass: "mass";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        door: "door";
+        window: "window";
+        furniture: "furniture";
+        space: "space";
+        slab: "slab";
+        roof: "roof";
+        column: "column";
+        beam: "beam";
+        staircase: "staircase";
+        referenceLine: "referenceLine";
+        curtainWall: "curtainWall";
+        mullion: "mullion";
+        panel: "panel";
+    }>>>;
+    minArea: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginStoreyOutlineOptions = z.input<typeof PluginStoreyOutlineOptions>;
+/**
+ * One connected footprint from {@link PluginDesignQueryApi.storeyOutline}.
+ * `outline` traces the OUTSIDE wall face; `holes` are the enclosed regions
+ * (rooms and courtyards). `enclosed` is `false` when the wall network does not
+ * close around any region (open C-shape) — don't slab an unenclosed outline
+ * without checking it.
+ */
+export declare const PluginStoreyFootprint: z.ZodObject<{
+    outline: z.ZodArray<z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>;
+    holes: z.ZodArray<z.ZodObject<{
+        ring: z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>>;
+        areaSq: z.ZodNumber;
+    }, z.core.$strip>>;
+    areaSq: z.ZodNumber;
+    enclosed: z.ZodBoolean;
+}, z.core.$strip>;
+export type PluginStoreyFootprint = z.infer<typeof PluginStoreyFootprint>;
+/** Result of {@link PluginDesignQueryApi.storeyOutline}. */
+export declare const PluginStoreyOutlineResult: z.ZodObject<{
+    footprints: z.ZodArray<z.ZodObject<{
+        outline: z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>>;
+        holes: z.ZodArray<z.ZodObject<{
+            ring: z.ZodArray<z.ZodObject<{
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>>;
+            areaSq: z.ZodNumber;
+        }, z.core.$strip>>;
+        areaSq: z.ZodNumber;
+        enclosed: z.ZodBoolean;
+    }, z.core.$strip>>;
+    discarded: z.ZodArray<z.ZodObject<{
+        areaSq: z.ZodNumber;
+        reason: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginStoreyOutlineResult = z.infer<typeof PluginStoreyOutlineResult>;
 export * from "./geometry";
 export * from "./spaces";
 export * from "./referenceLines";