@snaptrude/plugin-core 0.3.0 → 0.6.0

package/dist/api/core/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../../src/api/core/tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAAsB,iBAAiB;;IAGrC;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAErF;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;OAgBG;aACa,IAAI,CAClB,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,mBAAmB,CACjC,WAAW,EAAE,eAAe,GAC3B,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,cAAc,CAC5B,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAClE,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;OAiBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;OAkBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,MAAM,CACpB,YAAY,EAAE,eAAe,EAAE,EAC/B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,eAAe,EAAE,GAC9B,eAAe,CAAC,4BAA4B,CAAC;CACjD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa;;;;;iBAKxB,CAAA;AACF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;kBAAmC,CAAA;AAC/E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;kBAA2B,CAAA;AAC/D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;;iBAWzC,CAAA;AACJ,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,qFAAqF;AACrF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,oEAAoE;AACpE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,wEAAwE;AACxE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAKrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,+EAA+E;AAC/E,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAA0B,CAAA;AACnE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}

package/dist/api/core/units/index.d.ts

@@ -0,0 +1,175 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+/**
+ * Unit-type queries and conversion.
+ *
+ * Snaptrude stores all geometry in an internal `babylon` unit. These methods
+ * read the available unit types, the internal (`babylon`) type, and the current
+ * project type; set the current project type; and convert values between any two
+ * unit types.
+ *
+ * Accessed via `snaptrude.core.units`.
+ */
+export declare abstract class PluginUnitsApi {
+    constructor();
+    /**
+     * List the selectable real-world unit types (excludes the internal `babylon`
+     * storage type, which is read via {@linkcode PluginUnitsApi.getBabylonType}).
+     *
+     * @examplePrompt What units can I use in this project?
+     * @examplePrompt List all the available measurement units
+     * @examplePrompt Which unit systems does Snaptrude support?
+     * @examplePrompt Show the unit options I could switch the model to
+     *
+     * # Example
+     * ```ts
+     * const types = await snaptrude.core.units.listTypes()
+     * console.log(types) // ["meters", "feet-inches", "inches", ...]
+     * ```
+     */
+    abstract listTypes(): PluginApiReturn<PUnitType[]>;
+    /**
+     * Get the internal storage unit type that all geometry is kept in — always
+     * `"babylon"` — for use as one side of a {@linkcode PluginUnitsApi.convert} call.
+     *
+     * @examplePrompt What unit does Snaptrude store geometry in internally?
+     * @examplePrompt Get the internal babylon unit type
+     * @examplePrompt Which unit are raw model coordinates saved in?
+     *
+     * # Example
+     * ```ts
+     * const babylon = await snaptrude.core.units.getBabylonType() // "babylon"
+     * const meters = await snaptrude.core.units.convert(10, babylon, "meters")
+     * ```
+     */
+    abstract getBabylonType(): PluginApiReturn<PUnitType>;
+    /**
+     * Get the current project's unit type — the unit lengths are displayed and
+     * entered in. Paired with {@linkcode PluginUnitsApi.setType}.
+     *
+     * @examplePrompt What units is this project using?
+     * @examplePrompt Are we working in metric or imperial?
+     * @examplePrompt Check the current measurement unit of the model
+     * @examplePrompt Is the file set to millimetres or feet and inches?
+     *
+     * # Example
+     * ```ts
+     * const type = await snaptrude.core.units.getType()
+     * console.log(type) // e.g. "millimeters"
+     * ```
+     */
+    abstract getType(): PluginApiReturn<PUnitType>;
+    /**
+     * Set the current project's unit type. Paired with {@linkcode PluginUnitsApi.getType}.
+     *
+     * @param type - The unit type to set as the project unit.
+     * @returns `true` if applied; `false` if `type` is not a settable project unit
+     *   (e.g. `kilometers`, `miles`, `babylon`).
+     *
+     * @examplePrompt Change the project units to millimeters
+     * @examplePrompt Switch this model to feet and inches
+     * @examplePrompt Set the working units to metric
+     * @examplePrompt Make the drawing use centimetres instead of meters
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.units.setType("meters")
+     * ```
+     */
+    abstract setType(type: PUnitType): PluginApiReturn<boolean>;
+    /**
+     * Convert a value between two unit types.
+     *
+     * @param value - The numeric value to convert.
+     * @param from - Source unit type.
+     * @param to - Target unit type.
+     * @param degree - (Optional) 1 = length, 2 = area, 3 = volume. Defaults to 1.
+     * @returns The converted numeric value.
+     *
+     * @examplePrompt Convert 5 meters to feet and inches
+     * @examplePrompt How many millimetres is 12 feet?
+     * @examplePrompt Change this area from internal units to square metres
+     * @examplePrompt Turn 2500 mm into meters
+     * @examplePrompt Convert a volume value from babylon units to cubic feet
+     *
+     * # Example
+     * ```ts
+     * // 5 meters → internal babylon units
+     * const b = await snaptrude.core.units.convert(5, "meters", "babylon")
+     * // an internal area → square metres
+     * const m2 = await snaptrude.core.units.convert(area, "babylon", "meters", 2)
+     * ```
+     */
+    abstract convert(value: number, from: PUnitType, to: PUnitType, degree?: number): PluginApiReturn<number>;
+}
+/**
+ * Supported unit types. `babylon` is Snaptrude's internal storage unit; the rest
+ * are real-world units. Mirrors the engine `Converter.UNITS` vocabulary.
+ */
+export declare const PUnitType: z.ZodEnum<{
+    meters: "meters";
+    "feet-inches": "feet-inches";
+    inches: "inches";
+    centimeters: "centimeters";
+    millimeters: "millimeters";
+    kilometers: "kilometers";
+    miles: "miles";
+    babylon: "babylon";
+}>;
+export type PUnitType = z.infer<typeof PUnitType>;
+/**
+ * Arguments for {@linkcode PluginUnitsApi.setType}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `type` | {@linkcode PUnitType} | The unit type to set as the project unit |
+ */
+export declare const PluginUnitsSetTypeArgs: z.ZodObject<{
+    type: z.ZodEnum<{
+        meters: "meters";
+        "feet-inches": "feet-inches";
+        inches: "inches";
+        centimeters: "centimeters";
+        millimeters: "millimeters";
+        kilometers: "kilometers";
+        miles: "miles";
+        babylon: "babylon";
+    }>;
+}, z.core.$strip>;
+export type PluginUnitsSetTypeArgs = z.infer<typeof PluginUnitsSetTypeArgs>;
+/**
+ * Arguments for {@linkcode PluginUnitsApi.convert}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `value` | `number` | The numeric value to convert |
+ * | `from` | {@linkcode PUnitType} | Source unit type |
+ * | `to` | {@linkcode PUnitType} | Target unit type |
+ * | `degree` | `1 \| 2 \| 3` | (Optional) 1 = length, 2 = area, 3 = volume. Defaults to 1 |
+ */
+export declare const PluginUnitsConvertArgs: z.ZodObject<{
+    value: z.ZodNumber;
+    from: z.ZodEnum<{
+        meters: "meters";
+        "feet-inches": "feet-inches";
+        inches: "inches";
+        centimeters: "centimeters";
+        millimeters: "millimeters";
+        kilometers: "kilometers";
+        miles: "miles";
+        babylon: "babylon";
+    }>;
+    to: z.ZodEnum<{
+        meters: "meters";
+        "feet-inches": "feet-inches";
+        inches: "inches";
+        centimeters: "centimeters";
+        millimeters: "millimeters";
+        kilometers: "kilometers";
+        miles: "miles";
+        babylon: "babylon";
+    }>;
+    degree: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginUnitsConvertArgs = z.infer<typeof PluginUnitsConvertArgs>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/core/units/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/units/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;;;;;GASG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;IAEzD;;;;;;;;;;;;;OAaG;aACa,cAAc,IAAI,eAAe,CAAC,SAAS,CAAC;IAE5D;;;;;;;;;;;;;;OAcG;aACa,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC;IAErD;;;;;;;;;;;;;;;;OAgBG;aACa,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CACrB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,SAAS,EACf,EAAE,EAAE,SAAS,EACb,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;;;;EASpB,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;iBAEjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;iBAKjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA"}

package/dist/api/core/zoom/index.d.ts

@@ -0,0 +1,45 @@
+import { PluginApiReturn } from "../../../types";
+/**
+ * Camera zoom controls.
+ *
+ * Frame the viewport camera onto scene geometry — mirrors the canvas zoom menu
+ * ("Zoom extents" / "Zoom to selection"). Accessed via `snaptrude.core.zoom`.
+ */
+export declare abstract class PluginZoomApi {
+    constructor();
+    /**
+     * Zoom (fit) the camera to all geometry in the scene — the "zoom extents" action.
+     *
+     * @returns `true` once the camera has been framed to the scene.
+     *
+     * @examplePrompt Zoom out so I can see the whole model
+     * @examplePrompt Fit everything in the view
+     * @examplePrompt Frame the entire building in the viewport
+     * @examplePrompt Do a zoom extents on the canvas
+     * @examplePrompt Show me the full scene
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.zoom.extents()
+     * ```
+     */
+    abstract extents(): PluginApiReturn<boolean>;
+    /**
+     * Zoom (fit) the camera to the current selection.
+     *
+     * @returns `true` if there was a selection to frame; `false` if nothing is
+     *   selected (no-op).
+     *
+     * @examplePrompt Zoom in on what I have selected
+     * @examplePrompt Frame the selected walls in the view
+     * @examplePrompt Focus the camera on my current selection
+     * @examplePrompt Fit the view to the selected room
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.zoom.selection()
+     * ```
+     */
+    abstract selection(): PluginApiReturn<boolean>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/api/core/zoom/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/zoom/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;GAKG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;;;;OAeG;aACa,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC;IAEnD;;;;;;;;;;;;;;;OAeG;aACa,SAAS,IAAI,eAAe,CAAC,OAAO,CAAC;CACtD"}

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

@@ -0,0 +1,168 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+import { ComponentHandle } from "../../../handles";
+import { BooleanOutcome } from "../shared";
+/**
+ * `snaptrude.design.boolean` — OpenCascade CSG on scene masses/spaces.
+ *
+ * Every method **commits** the operation as one undoable step (engine `run()`
+ * queues create/delete/group/dimension commands, `execute()` runs them through
+ * `CommandManager`) and returns the committed {@linkcode BooleanOutcome}. Failures
+ * **throw** (RPC rejects) — no `Result<>` monad crosses the boundary.
+ *
+ * Eligibility (all inputs): a `Mass` that is a room OR a DEPARTMENT, has a brep, is
+ * unlocked (mesh + bucket), visible, and NOT in a parametric-copy group; the whole
+ * set must be all-planar OR all-non-planar; **≥2** components; all inputs share one
+ * group or are ungrouped; inputs must be adjacent/overlapping.
+ *
+ * `design.boolean.subtract` is a **CSG geometry delete** — distinct from
+ * `design.delete.entities` (hard entity removal) and `design.erase.edge`
+ * (adjacency-edge topology op).
+ *
+ * TRANSPORT: positional args per method.
+ */
+export declare abstract class PluginDesignBooleanApi {
+    constructor();
+    /**
+     * Fuse two or more masses into a single combined mass (`A ∪ B ∪ …`) — a boolean
+     * (CSG) union that merges the adjacent or overlapping inputs into one solid,
+     * committed as a single undoable step. Order-independent.
+     * @param components - The ≥2 entities to fuse (order-independent)
+     * @param options - Optional output offset — {@linkcode BooleanOptions}
+     * @returns The committed CSG delta — {@linkcode BooleanOutcome}
+     * @throws if inputs are ineligible, disjoint, non-manifold when joined, span
+     *   different groups, or the CSG yields no / invalid geometry.
+     *
+     * @examplePrompt Merge these two masses into one
+     * @examplePrompt Union the selected volumes into a single mass
+     * @examplePrompt Combine the overlapping rooms into one shape
+     * @examplePrompt Join the tower and podium blocks together
+     * @examplePrompt Fuse all the selected massing blocks into a single solid
+     *
+     * # Example
+     * ```ts
+     * // Fuse the overlapping massing blocks on the ground storey into one solid
+     * const masses = await snaptrude.design.query.listMasses({ storeys: [1] })
+     * const { created, deleted } = await snaptrude.design.boolean.union(masses)
+     * console.log("created", created.length, "mass; consumed", deleted.length)
+     * ```
+     */
+    abstract union(components: ComponentHandle[], options?: BooleanOptions): PluginApiReturn<BooleanOutcome>;
+    /**
+     * Cut one or more tool masses out of a target mass (`target − ⋃tools`) — a
+     * boolean (CSG) subtraction that carves the tools' volume out of the target and
+     * commits the remainder as a single undoable step.
+     *
+     * ORDER-SENSITIVE: the host seeds `[target, ...tools]`; index 0 is the arg brep,
+     * the rest are tool breps. `deleted` includes the target AND every tool;
+     * `created` is the remainder mass(es).
+     * @param target - The entity subtracted FROM (arg brep)
+     * @param tools - The ≥1 entities subtracted (tool breps)
+     * @param options - Optional output offset — {@linkcode BooleanOptions}
+     * @returns The committed CSG delta — {@linkcode BooleanOutcome}
+     * @throws as {@linkcode union}; a `NoResult` here carries the "select the target
+     *   object first" hint from the engine.
+     *
+     * @examplePrompt Cut this shape out of the bigger mass
+     * @examplePrompt Subtract the cylinder from the building volume
+     * @examplePrompt Punch an opening through this block using the small box
+     * @examplePrompt Carve the courtyard volume out of the main massing
+     * @examplePrompt Remove the overlapping part of mass B from mass A
+     *
+     * # Example
+     * ```ts
+     * // Order matters: the first arg is the target, the array holds the tools
+     * const [building, courtyard] = await snaptrude.design.selection.get()
+     * const { created, deleted } = await snaptrude.design.boolean.subtract(building, [courtyard])
+     * // deleted includes the target AND every tool; created is the remainder
+     * ```
+     */
+    abstract subtract(target: ComponentHandle, tools: ComponentHandle[], options?: BooleanOptions): PluginApiReturn<BooleanOutcome>;
+    /**
+     * Keep only the overlapping volume of exactly two masses (`A ∩ B`) — a boolean
+     * (CSG) intersection that discards everything outside the shared region and
+     * commits the overlap as a single undoable step. Order-independent.
+     *
+     * HARD constraint: **EXACTLY 2** components (schema `.length(2)`; the engine
+     * also throws `MoreThan2ComponentsForIntersect` on >2).
+     * @param components - **EXACTLY 2** entities to intersect (order-independent)
+     * @param options - Optional output offset — {@linkcode BooleanOptions}
+     * @returns The committed CSG delta — {@linkcode BooleanOutcome}
+     * @throws as {@linkcode union}, plus `MoreThan2ComponentsForIntersect` on >2.
+     *
+     * @examplePrompt Keep only the part where these two masses overlap
+     * @examplePrompt Intersect the two selected volumes
+     * @examplePrompt Give me the common volume between the tower and the zoning envelope
+     * @examplePrompt Trim this mass down to just its overlap with the other one
+     *
+     * # Example
+     * ```ts
+     * // Keep only the overlap of the tower and the zoning envelope (EXACTLY 2 inputs),
+     * // shifting the result mass 10 units in x via the optional offset
+     * const [tower, envelope] = await snaptrude.design.query.listMasses()
+     * const offset = await snaptrude.core.math.vec3.new(10, 0, 0)
+     * const { created } = await snaptrude.design.boolean.intersect([tower, envelope], { offset })
+     * ```
+     */
+    abstract intersect(components: ComponentHandle[], options?: BooleanOptions): PluginApiReturn<BooleanOutcome>;
+}
+/**
+ * Optional knobs shared by all boolean ops. The only safe one is a world-space
+ * translation applied to the output mass(es) — maps to `Boolean3dOperation.offset`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `offset` | {@linkcode Vec3Handle} | Translation added to the created result mass(es) (default: none) |
+ */
+export declare const BooleanOptions: z.ZodObject<{
+    offset: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+}, z.core.$strip>;
+export type BooleanOptions = z.infer<typeof BooleanOptions>;
+/**
+ * Arguments for {@linkcode PluginDesignBooleanApi.union}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | The ≥2 entities to fuse (order-independent) |
+ * | `options` | {@linkcode BooleanOptions} | Optional output offset |
+ */
+export declare const PluginDesignBooleanUnionArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    options: z.ZodOptional<z.ZodObject<{
+        offset: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginDesignBooleanUnionArgs = z.infer<typeof PluginDesignBooleanUnionArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignBooleanApi.subtract}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `target` | {@linkcode ComponentHandle} | The entity subtracted FROM (arg brep) |
+ * | `tools` | {@linkcode ComponentHandle}`[]` | The ≥1 entities subtracted (tool breps) |
+ * | `options` | {@linkcode BooleanOptions} | Optional output offset |
+ */
+export declare const PluginDesignBooleanSubtractArgs: z.ZodObject<{
+    target: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    tools: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    options: z.ZodOptional<z.ZodObject<{
+        offset: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginDesignBooleanSubtractArgs = z.infer<typeof PluginDesignBooleanSubtractArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignBooleanApi.intersect}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | **EXACTLY 2** entities to intersect (order-independent) |
+ * | `options` | {@linkcode BooleanOptions} | Optional output offset |
+ */
+export declare const PluginDesignBooleanIntersectArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    options: z.ZodOptional<z.ZodObject<{
+        offset: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginDesignBooleanIntersectArgs = z.infer<typeof PluginDesignBooleanIntersectArgs>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/design/boolean/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/boolean/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAc,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,KAAK,CACnB,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,eAAe,CAAC,cAAc,CAAC;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,QAAQ,CACtB,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,eAAe,EAAE,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,eAAe,CAAC,cAAc,CAAC;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,eAAe,CAAC,cAAc,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;iBAEzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;iBAI1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA"}