@snaptrude/plugin-core 0.10.0 → 1.0.0

package/dist/api/design/create/bulk-items.d.ts

@@ -0,0 +1,269 @@
+import * as z from "zod";
+import { ComponentHandle } from "../../../handles";
+/**
+ * Maximum items per bulk `design.create.*` call. A bounded request keeps
+ * validation, command capture and rollback work finite; split a larger import
+ * into separate awaited batches, each with its own undo entry.
+ */
+export declare const PLUGIN_CREATE_BATCH_LIMIT = 1000;
+/**
+ * One break point of a wall's top edge — see {@linkcode PluginWallTopProfile}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `along` | `number` | Position along the wall centerline as a fraction: `0` = start of the curve, `1` = end |
+ * | `height` | `number` | Top height above the wall base at that point (Snaptrude units, > 0) |
+ */
+export declare const PluginWallTopProfilePoint: z.ZodObject<{
+    along: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginWallTopProfilePoint = z.infer<typeof PluginWallTopProfilePoint>;
+/**
+ * The top edge of ONE wall as a polyline over its centerline: at least two
+ * points, `along` strictly increasing from `0` (curve start) to `1` (curve end),
+ * straight segments between them. Two points give a single slope (a raked
+ * wall), three give a gable, more give any stepped or folded ridge. Heights are
+ * measured from the wall base, like `height`. Both long faces follow the same
+ * profile, so the top stays a set of flat faces and the wall keeps its thickness
+ * end to end.
+ *
+ * Only straight centerlines take a top profile (an arc curve with one is
+ * rejected). A wall built this way is a real Wall — doors and windows host on
+ * it, corners mitre, quantities and Revit export read its geometry — but it is
+ * **non-parametric**: the parametric wall graph does not rebuild it, so a later
+ * move of a neighbour does not re-mitre its corner, exactly like a wall whose
+ * top edge was dragged by hand. `design.update.wall({ height })` scales it
+ * proportionally.
+ */
+export declare const PluginWallTopProfile: z.ZodArray<z.ZodObject<{
+    along: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>>;
+export type PluginWallTopProfile = z.infer<typeof PluginWallTopProfile>;
+/**
+ * One wall run to create via {@linkcode PluginDesignCreateApi.wallRuns} — the
+ * same inputs as {@linkcode PluginDesignCreateApi.walls}, one run per item.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `profile` | {@linkcode ProfileHandle} | Ordered curve chain (wall centerlines) |
+ * | `height` | `number`? | Wall height (Snaptrude units, > 0; default engine default) |
+ * | `thickness` | `number`? | Wall thickness (Snaptrude units, > 0; default: `wallType`'s total layer thickness when given, else engine default) |
+ * | `wallType` | {@linkcode PluginWallType}? | Legacy name/id or exact native `{ id, version }` pin from `design.types.list("wall")` (default generic) |
+ * | `storey` | `number`? (int) | Target storey (must exist) — the run's walls are assigned + lifted to its base in the same undo entry (default: geometry-derived) |
+ * | `topProfiles` | ({@linkcode PluginWallTopProfile} \| `null`)[]? | Top edge per curve of `profile`, same order; a `null` or missing entry keeps that wall flat at `height`. Raked / gabled walls (straight curves only) |
+ */
+export declare const PluginCreateWallRunItem: z.ZodObject<{
+    profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"profile">, string>>;
+    height: z.ZodOptional<z.ZodNumber>;
+    thickness: z.ZodOptional<z.ZodNumber>;
+    wallType: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>]>>;
+    storey: z.ZodOptional<z.ZodNumber>;
+    topProfiles: z.ZodOptional<z.ZodArray<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        along: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>>>>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+}, z.core.$strip>;
+export type PluginCreateWallRunItem = z.infer<typeof PluginCreateWallRunItem>;
+/** The `items` array of {@linkcode PluginDesignCreateApi.wallRuns} (1…1000). */
+export declare const PluginCreateWallRunItems: z.ZodArray<z.ZodObject<{
+    profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"profile">, string>>;
+    height: z.ZodOptional<z.ZodNumber>;
+    thickness: z.ZodOptional<z.ZodNumber>;
+    wallType: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>]>>;
+    storey: z.ZodOptional<z.ZodNumber>;
+    topProfiles: z.ZodOptional<z.ZodArray<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        along: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>>>>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+}, z.core.$strip>>;
+export type PluginCreateWallRunItems = z.infer<typeof PluginCreateWallRunItems>;
+/**
+ * One floor to create via {@linkcode PluginDesignCreateApi.floors} — the same
+ * footprint-extrude inputs as {@linkcode PluginDesignCreateApi.floor}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `contour` | {@linkcode ContourHandle} | Footprint (outer profile + holes) |
+ * | `thickness` | `number` | Floor thickness (Snaptrude units, > 0) |
+ * | `position` | {@linkcode Vec3Handle}? | Offset from origin (default origin) |
+ */
+export declare const PluginCreateFloorItem: z.ZodObject<{
+    contour: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"contour">, string>>;
+    thickness: z.ZodNumber;
+    position: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+}, z.core.$strip>;
+export type PluginCreateFloorItem = z.infer<typeof PluginCreateFloorItem>;
+/** The `items` array of {@linkcode PluginDesignCreateApi.floors} (1…1000). */
+export declare const PluginCreateFloorItems: z.ZodArray<z.ZodObject<{
+    contour: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"contour">, string>>;
+    thickness: z.ZodNumber;
+    position: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+}, z.core.$strip>>;
+export type PluginCreateFloorItems = z.infer<typeof PluginCreateFloorItems>;
+/**
+ * One door to place via {@linkcode PluginDesignCreateApi.doors} — the same
+ * fields as a `"door"` {@linkcode PluginDesignCreateOpeningOptions}.
+ * Values are evaluated before cutting. Numeric lengths use SU; unit strings
+ * are accepted in values. `facing` selects local +Z; `hinge` sets the declared
+ * hand enum (left = local -X, right = +X). Both are world points.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `familyId` | `string` | Hosted door family definition ID |
+ * | `version` | `number`? | Exact version; newest known by default |
+ * | `values` | `Record<string, number \| string>`? | Authored parameter overrides |
+ * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the door |
+ * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
+ * | `facing` | {@linkcode Vec3Handle}? | World point on the side the door swings open to (default engine-chosen) |
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires hand control |
+ * | `label` | `string`? | Instance name (optional) |
+ * | `width` | `number`? | Declared width parameter (SU, > 0), not evaluated hole width |
+ * | `height` | `number`? | Declared height parameter (SU, > 0) |
+ */
+export declare const PluginCreateDoorItem: z.ZodObject<{
+    familyId: z.ZodString;
+    version: z.ZodOptional<z.ZodNumber>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    label: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCreateDoorItem = z.infer<typeof PluginCreateDoorItem>;
+/** The `items` array of {@linkcode PluginDesignCreateApi.doors} (1…1000). */
+export declare const PluginCreateDoorItems: z.ZodArray<z.ZodObject<{
+    familyId: z.ZodString;
+    version: z.ZodOptional<z.ZodNumber>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    label: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>>;
+export type PluginCreateDoorItems = z.infer<typeof PluginCreateDoorItems>;
+/**
+ * One window to place via {@linkcode PluginDesignCreateApi.windows} — the same
+ * fields as a `"window"` {@linkcode PluginDesignCreateOpeningOptions}.
+ * `sillHeight` is a nonnegative Snaptrude-unit distance from the host wall's
+ * base to the BOTTOM of the window, not to its center. `facing` and `hinge`
+ * are WORLD POINTS, not directions: `facing` on the side of the wall the
+ * window opens to, `hinge` near the jamb it is hinged on. Rejects unknown
+ * fields.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `familyId` | `string` | Hosted window family definition ID |
+ * | `version` | `number`? | Exact version; newest known by default |
+ * | `values` | `Record<string, number \| string>`? | Authored parameter overrides; numeric lengths use SU |
+ * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the window |
+ * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
+ * | `facing` | {@linkcode Vec3Handle}? | World point on the side the window opens to (default engine-chosen) |
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires hand control |
+ * | `label` | `string`? | Instance name (optional) |
+ * | `width` | `number`? | Declared width parameter (SU, > 0), not evaluated hole width |
+ * | `height` | `number`? | Declared height parameter (SU, > 0) |
+ * | `sillHeight` | `number`? | Declared sill parameter (SU, ≥ 0); position Y is ignored |
+ */
+export declare const PluginCreateWindowItem: z.ZodObject<{
+    sillHeight: z.ZodOptional<z.ZodNumber>;
+    familyId: z.ZodString;
+    version: z.ZodOptional<z.ZodNumber>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    label: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCreateWindowItem = z.infer<typeof PluginCreateWindowItem>;
+/** The `items` array of {@linkcode PluginDesignCreateApi.windows} (1…1000). */
+export declare const PluginCreateWindowItems: z.ZodArray<z.ZodObject<{
+    sillHeight: z.ZodOptional<z.ZodNumber>;
+    familyId: z.ZodString;
+    version: z.ZodOptional<z.ZodNumber>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    label: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>>;
+export type PluginCreateWindowItems = z.infer<typeof PluginCreateWindowItems>;
+/**
+ * One furniture instance to place via
+ * {@linkcode PluginDesignCreateApi.furnitureItems} — the same inputs as
+ * {@linkcode PluginDesignCreateApi.furniture} minus `createNewSourceMesh`: in a
+ * batch the host owns source-mesh persistence (a source is recorded once per
+ * call, however many items reuse it).
+ *
+ * `position.y` is the REST elevation: the item is grounded so its bounding-box
+ * base sits exactly at `position.y` (the same surface-flush contract as
+ * interactive drag-drop) — pass the floor/storey elevation to stand furniture
+ * on it; never add half the item's height yourself.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
+ * | `position` | {@linkcode Vec3Handle} | Absolute world placement point (`y` = rest elevation) |
+ * | `label` | `string`? | Instance name and readable label (default auto `${name}Ins${n}`) |
+ * | `angleInDegrees` | `number`? | Rotation about the vertical axis, in degrees (default unrotated) |
+ */
+export declare const PluginCreateFurnitureItem: z.ZodObject<{
+    catalogId: z.ZodString;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    label: z.ZodOptional<z.ZodString>;
+    angleInDegrees: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginCreateFurnitureItem = z.infer<typeof PluginCreateFurnitureItem>;
+/**
+ * The `items` array of {@linkcode PluginDesignCreateApi.furnitureItems}
+ * (1…1000).
+ */
+export declare const PluginCreateFurnitureItems: z.ZodArray<z.ZodObject<{
+    catalogId: z.ZodString;
+    position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    label: z.ZodOptional<z.ZodString>;
+    angleInDegrees: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+export type PluginCreateFurnitureItems = z.infer<typeof PluginCreateFurnitureItems>;
+/**
+ * One void to cut via {@linkcode PluginDesignCreateApi.voids} — the same fields as
+ * {@linkcode PluginDesignCreateApi.void}. Rejects unknown fields.
+ *
+ * | Property | Type | Description |
+ * | --- | --- | --- |
+ * | `host` | {@linkcode ComponentHandle} | The slab, floor, roof or ceiling to cut through. Not a wall. |
+ * | `outline` | {@linkcode ProfileHandle} | Closed, flat plan outline in world SU (all points at one height). That height is ignored: it is dropped straight onto the host's top face. |
+ */
+export declare const PluginCreateVoidItem: z.ZodObject<{
+    host: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    outline: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"profile">, string>>;
+}, z.core.$strict>;
+export type PluginCreateVoidItem = z.infer<typeof PluginCreateVoidItem>;
+/** The `items` array of {@linkcode PluginDesignCreateApi.voids} (1…1000; the host takes at most 200, 50 per host). */
+export declare const PluginCreateVoidItems: z.ZodArray<z.ZodObject<{
+    host: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    outline: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"profile">, string>>;
+}, z.core.$strict>>;
+export type PluginCreateVoidItems = z.infer<typeof PluginCreateVoidItems>;
+//# sourceMappingURL=bulk-items.d.ts.map

package/dist/api/design/create/bulk-items.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-items.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/bulk-items.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,kBAAkB,CAAA;AAKzB;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,OAAO,CAAA;AAM7C;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB;;;kBA0B7B,CAAA;AACJ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAMvE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;iBASlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,gFAAgF;AAChF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;kBAGJ,CAAA;AACjC,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAM/E;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,8EAA8E;AAC9E,eAAO,MAAM,sBAAsB;;;;kBAGF,CAAA;AACjC,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAM3E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;kBAEtB,CAAA;AACX,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB;;;;;;;;;;;mBAGD,CAAA;AACjC,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;kBAKxB,CAAA;AACX,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;mBAGH,CAAA;AACjC,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAM7E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,yBAAyB;;;;;iBAKpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;kBAGN,CAAA;AACjC,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;kBAKtB,CAAA;AACX,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,sHAAsH;AACtH,eAAO,MAAM,qBAAqB;;;mBAGD,CAAA;AACjC,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}

package/dist/api/design/create/grids.d.ts

@@ -0,0 +1,132 @@
+import * as z from "zod";
+import { ComponentHandle } from "../../../handles";
+/**
+ * Grid line style (mirrors the engine `LineMode` values verbatim — the same
+ * vocabulary as {@linkcode PluginReferenceLineStyle}).
+ */
+export declare const PluginGridLineStyle: z.ZodEnum<{
+    SOLID: "SOLID";
+    DASHED: "DASHED";
+    DOT_DASH: "DOT_DASH";
+}>;
+export type PluginGridLineStyle = z.infer<typeof PluginGridLineStyle>;
+/**
+ * Optional visual styling shared by every grid creator (and reused as the
+ * patch shape by `design.update.grid`). All fields optional; engine defaults
+ * apply when omitted.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `style` | {@linkcode PluginGridLineStyle}? | Line style |
+ * | `weight` | `number`? | Line weight (> 0) |
+ * | `color` | `string`? | Line color as a `#rrggbb` hex string |
+ * | `showStart` | `boolean`? | Show the start-end tag bubble |
+ * | `showEnd` | `boolean`? | Show the end-end tag bubble |
+ */
+export declare const PluginGridStyleOptions: z.ZodObject<{
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginGridStyleOptions = z.infer<typeof PluginGridStyleOptions>;
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.grid}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `linesX` | `number` | Line count of the first family (integer ≥ 1) |
+ * | `linesY` | `number` | Line count of the second family (integer ≥ 1) |
+ * | `spacingX` | `number` | Spacing of the first family (Snaptrude units, > 0) |
+ * | `spacingY` | `number` | Spacing of the second family (Snaptrude units, > 0) |
+ * | `angle` | `number`? | Rotation in degrees, CCW about +Y (default 0) |
+ * | `center` | {@linkcode Vec3Handle}? | Placement centre; defaults to the native viewport-centre behavior |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export declare const PluginDesignCreateGridArgs: z.ZodObject<{
+    linesX: z.ZodNumber;
+    linesY: z.ZodNumber;
+    spacingX: z.ZodNumber;
+    spacingY: z.ZodNumber;
+    angle: z.ZodOptional<z.ZodNumber>;
+    center: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridArgs = z.infer<typeof PluginDesignCreateGridArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.gridFromCurve}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The grid line's geometry — a line or arc (circles are rejected) |
+ * | `tag` | `string`? | The line's grid tag (defaults to the draw tool's next tag) |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export declare const PluginDesignCreateGridFromCurveArgs: z.ZodObject<{
+    curve: z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"arc">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"spline">, string>>]>;
+    tag: z.ZodOptional<z.ZodString>;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridFromCurveArgs = z.infer<typeof PluginDesignCreateGridFromCurveArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.gridsFromMasses}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `masses` | {@linkcode ComponentHandle}`[]` | Masses whose footprints seat the grids |
+ * | `spacingX` | `number` | First-family spacing (Snaptrude units, > 0) |
+ * | `spacingY` | `number` | Second-family spacing (Snaptrude units, > 0) |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export declare const PluginDesignCreateGridsFromMassesArgs: z.ZodObject<{
+    masses: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    spacingX: z.ZodNumber;
+    spacingY: z.ZodNumber;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridsFromMassesArgs = z.infer<typeof PluginDesignCreateGridsFromMassesArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.columnsFromGrids}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `grids` | {@linkcode ComponentHandle}`[]` | Grid groups whose line intersections seat the columns |
+ * | `width` | `number` | Column width (Snaptrude units, > 0) |
+ * | `depth` | `number` | Column depth (Snaptrude units, > 0) |
+ */
+export declare const PluginDesignCreateColumnsFromGridsArgs: z.ZodObject<{
+    grids: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    width: z.ZodNumber;
+    depth: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginDesignCreateColumnsFromGridsArgs = z.infer<typeof PluginDesignCreateColumnsFromGridsArgs>;
+//# sourceMappingURL=grids.d.ts.map

package/dist/api/design/create/grids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grids.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/grids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAA2B,MAAM,kBAAkB,CAAA;AAM3E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;EAA0C,CAAA;AAC1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;iBASjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAM3E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;iBASP,CAAA;AAChC,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAMnF;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;iBAKhB,CAAA;AAChC,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAMD;;;;;;;;;GASG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;iBAMlB,CAAA;AAChC,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,sCAAsC;;;;iBAIjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA"}