@snaptrude/plugin-core 0.11.0-rc.1 → 1.0.0

package/dist/api/design/catalog.d.ts

@@ -0,0 +1,320 @@
+import * as z from "zod";
+import type { PluginApiReturn } from "../../types";
+/** Exact saved family identity. A label or a selected Draw type is not an identity. */
+export declare const PluginSavedFamilyReference: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strict>;
+export type PluginSavedFamilyReference = z.infer<typeof PluginSavedFamilyReference>;
+/** Public overrides: physical lengths use mm, angles use degrees. Omitted values retain defaults. */
+export declare const PluginFamilyValues: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>;
+export type PluginFamilyValues = z.infer<typeof PluginFamilyValues>;
+/** Native construction uses a saved family or a project assembly token from the catalogue. */
+export declare const PluginConstructionType: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strict>, z.ZodString]>;
+export type PluginConstructionType = z.infer<typeof PluginConstructionType>;
+/** Family owns its layers/section. Geometry owns the footprint/axis; it is never a values override. */
+export declare const PluginFamilyPlacement: z.ZodObject<{
+    type: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+}, z.core.$strict>;
+export type PluginFamilyPlacement = z.infer<typeof PluginFamilyPlacement>;
+/** Sparse native family edit. Omitted type keeps the component's exact saved reference. */
+export declare const PluginFamilyUpdates: z.ZodObject<{
+    type: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>>;
+    values: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>>;
+}, z.core.$strict>;
+export type PluginFamilyUpdates = z.infer<typeof PluginFamilyUpdates>;
+export declare const PluginFamilyFloorOptions: z.ZodObject<{
+    type: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+    position: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>>;
+}, z.core.$strict>;
+export type PluginFamilyFloorOptions = z.infer<typeof PluginFamilyFloorOptions>;
+export declare const PluginFamilySlabOptions: z.ZodObject<{
+    type: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+    direction: z.ZodOptional<z.ZodEnum<{
+        up: "up";
+        down: "down";
+    }>>;
+}, z.core.$strict>;
+export type PluginFamilySlabOptions = z.infer<typeof PluginFamilySlabOptions>;
+export declare const PluginFamilyCeilingOptions: z.ZodObject<{
+    type: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+    heightFromFloor: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginFamilyCeilingOptions = z.infer<typeof PluginFamilyCeilingOptions>;
+export declare const PluginFamilyContourArgs: z.ZodObject<{
+    contour: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"contour">, string>>;
+    options: z.ZodObject<{
+        type: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strict>, z.ZodString]>;
+        values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+    }, z.core.$strict>;
+}, z.core.$strip>;
+export declare const PluginFamilyAxisArgs: z.ZodObject<{
+    axis: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"line">, string>>;
+    options: z.ZodObject<{
+        type: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strict>, z.ZodString]>;
+        values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
+    }, z.core.$strict>;
+}, z.core.$strip>;
+/** Inventory includes architectural recipes, ordinary PCs, and the existing placement libraries. */
+export declare const PluginCatalogKind: z.ZodEnum<{
+    component: "component";
+    floor: "floor";
+    wall: "wall";
+    ceiling: "ceiling";
+    slab: "slab";
+    roof: "roof";
+    furniture: "furniture";
+    door: "door";
+    window: "window";
+    beam: "beam";
+    column: "column";
+}>;
+export type PluginCatalogKind = z.infer<typeof PluginCatalogKind>;
+export declare const PluginCatalogReference: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strict>, z.ZodString]>;
+export type PluginCatalogReference = z.infer<typeof PluginCatalogReference>;
+/** Read-only capability record. Availability is checked again on every mutation. */
+export declare const PluginCatalogEntry: z.ZodObject<{
+    reference: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    label: z.ZodString;
+    kind: z.ZodEnum<{
+        component: "component";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        slab: "slab";
+        roof: "roof";
+        furniture: "furniture";
+        door: "door";
+        window: "window";
+        beam: "beam";
+        column: "column";
+    }>;
+    source: z.ZodEnum<{
+        native: "native";
+        revit: "revit";
+        project: "project";
+        asset: "asset";
+    }>;
+    createMethods: z.ZodArray<z.ZodString>;
+    updateMethods: z.ZodArray<z.ZodString>;
+    requirements: z.ZodArray<z.ZodString>;
+    unsupportedReason: z.ZodOptional<z.ZodString>;
+    parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<{
+            boolean: "boolean";
+            enum: "enum";
+            length: "length";
+            text: "text";
+            integer: "integer";
+        }>;
+        unit: z.ZodOptional<z.ZodEnum<{
+            mm: "mm";
+            degrees: "degrees";
+        }>>;
+        default: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        drivesGeometry: z.ZodBoolean;
+        readOnly: z.ZodBoolean;
+        formulaDriven: z.ZodBoolean;
+        isInstance: z.ZodBoolean;
+    }, z.core.$strip>>>;
+    geometryParameters: z.ZodArray<z.ZodString>;
+    network: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<1>;
+        role: z.ZodEnum<{
+            pipe: "pipe";
+            duct: "duct";
+            wire: "wire";
+            cable: "cable";
+            conduit: "conduit";
+            cableDuct: "cableDuct";
+            cableTray: "cableTray";
+            connector: "connector";
+            equipment: "equipment";
+        }>;
+        lengthParameter: z.ZodOptional<z.ZodString>;
+        ports: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            position: z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>;
+            direction: z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>;
+            size: z.ZodString;
+            height: z.ZodOptional<z.ZodString>;
+            widthDirection: z.ZodOptional<z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>>;
+            systems: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    construction: z.ZodOptional<z.ZodObject<{
+        root: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        deps: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+        network: z.ZodOptional<z.ZodObject<{
+            schemaVersion: z.ZodLiteral<1>;
+            role: z.ZodEnum<{
+                pipe: "pipe";
+                duct: "duct";
+                wire: "wire";
+                cable: "cable";
+                conduit: "conduit";
+                cableDuct: "cableDuct";
+                cableTray: "cableTray";
+                connector: "connector";
+                equipment: "equipment";
+            }>;
+            lengthParameter: z.ZodOptional<z.ZodString>;
+            ports: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                position: z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>;
+                direction: z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>;
+                size: z.ZodString;
+                height: z.ZodOptional<z.ZodString>;
+                widthDirection: z.ZodOptional<z.ZodTuple<[z.ZodString, z.ZodString, z.ZodString], null>>;
+                systems: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCatalogEntry = z.infer<typeof PluginCatalogEntry>;
+export declare const PluginCatalogListArgs: z.ZodObject<{
+    kind: z.ZodOptional<z.ZodEnum<{
+        component: "component";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        slab: "slab";
+        roof: "roof";
+        furniture: "furniture";
+        door: "door";
+        window: "window";
+        beam: "beam";
+        column: "column";
+    }>>;
+}, z.core.$strip>;
+export declare const PluginCatalogGetArgs: z.ZodObject<{
+    reference: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+}, z.core.$strip>;
+/** Search metadata is extensible. A slash separates category path segments. */
+export declare const PluginCatalogSearchArgs: z.ZodObject<{
+    query: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type PluginCatalogSearchArgs = z.infer<typeof PluginCatalogSearchArgs>;
+/** Browse one hierarchy level without enumerating families or fetching recipe bodies. */
+export declare const PluginCatalogListCategoriesArgs: z.ZodObject<{
+    parent: z.ZodOptional<z.ZodString>;
+    after: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCatalogListCategoriesArgs = z.infer<typeof PluginCatalogListCategoriesArgs>;
+/** Metadata only: the category does not establish placement capabilities or recipe validity. */
+export declare const PluginCatalogCategory: z.ZodObject<{
+    categoryPath: z.ZodArray<z.ZodString>;
+    hasChildren: z.ZodBoolean;
+}, z.core.$strip>;
+export type PluginCatalogCategory = z.infer<typeof PluginCatalogCategory>;
+/** Metadata only. Read get(reference) to validate a selected family and inspect placement methods. */
+export declare const PluginCatalogSummary: z.ZodObject<{
+    reference: z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>;
+    label: z.ZodString;
+    categoryPath: z.ZodArray<z.ZodString>;
+    description: z.ZodString;
+    source: z.ZodEnum<{
+        native: "native";
+        revit: "revit";
+        project: "project";
+        asset: "asset";
+    }>;
+}, z.core.$strip>;
+export type PluginCatalogSummary = z.infer<typeof PluginCatalogSummary>;
+export declare const PluginCatalogSearchResult: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        reference: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strict>, z.ZodString]>;
+        label: z.ZodString;
+        categoryPath: z.ZodArray<z.ZodString>;
+        description: z.ZodString;
+        source: z.ZodEnum<{
+            native: "native";
+            revit: "revit";
+            project: "project";
+            asset: "asset";
+        }>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PluginCatalogSearchResult = z.infer<typeof PluginCatalogSearchResult>;
+/** Shared read surface over existing libraries. Does not publish, register, or place definitions. */
+export declare abstract class PluginDesignCatalogApi {
+    /**
+     * Discover categories from accessible saved families and current project constructions.
+     * Omit parent for roots; pass a slash-separated returned path for its direct children.
+     * This metadata read does not fetch recipes, include unsaved drafts or legacy mesh inventories,
+     * or establish capabilities. Use search then get before placement. Names retain their case.
+     * @param args Parent path, exclusive after-name, and page limit (default 50, maximum 100).
+     * For another page at the same parent, pass the last item's final categoryPath segment as after.
+     * @returns Categories in Unicode code-point order, with descendant flags. Stop when a page has
+     * fewer than limit items. Live pagination is not a snapshot. Metadata-service failures reject.
+     */
+    abstract listCategories(args?: PluginCatalogListCategoriesArgs): PluginApiReturn<PluginCatalogCategory[]>;
+    /**
+     * Search accessible saved-family and project-construction metadata without downloading recipes.
+     * Categories are data, not an SDK enum. Legacy mesh inventories and unsaved drafts are excluded.
+     * Inspect selected references with get before placement; a search match does not prove validity
+     * or supported behavior. Pagination reads live data, not a snapshot. Failures reject.
+     * @param args Text/category filters, page limit (default 20, maximum 50), and opaque cursor.
+     * @returns Compact metadata and continuation. Continue until nextCursor is null or a suitable
+     * family is found. Concurrent changes can leave an empty page with continuation.
+     */
+    abstract search(args?: PluginCatalogSearchArgs): PluginApiReturn<PluginCatalogSearchResult>;
+    /** @param kind Optional element filter. @returns Accessible entries and their supported API paths. */
+    abstract list(kind?: PluginCatalogKind): PluginApiReturn<PluginCatalogEntry[]>;
+    /** @param reference Exact reference from search or list. @returns The current entry, or null when unavailable. */
+    abstract get(reference: PluginCatalogReference): PluginApiReturn<PluginCatalogEntry | null>;
+}
+//# sourceMappingURL=catalog.d.ts.map

package/dist/api/design/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../../src/api/design/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAOlD,uFAAuF;AACvF,eAAO,MAAM,0BAA0B;;;kBAK5B,CAAA;AACX,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,qGAAqG;AACrG,eAAO,MAAM,kBAAkB,yFAG9B,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE,8FAA8F;AAC9F,eAAO,MAAM,sBAAsB;;;iCAGjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,uGAAuG;AACvG,eAAO,MAAM,qBAAqB;;;;;;kBAKvB,CAAA;AACX,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,2FAA2F;AAC3F,eAAO,MAAM,mBAAmB;;;;;;kBAG/B,CAAA;AACD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE,eAAO,MAAM,wBAAwB;;;;;;;kBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;kBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC7E,eAAO,MAAM,0BAA0B;;;;;;;kBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AACD,eAAO,MAAM,uBAAuB;;;;;;;;;iBAGlC,CAAA;AACF,eAAO,MAAM,oBAAoB;;;;;;;;;iBAG/B,CAAA;AAEF,oGAAoG;AACpG,eAAO,MAAM,iBAAiB;;;;;;;;;;;;EAY5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACjE,eAAO,MAAM,sBAAsB;;;iCAIjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,oFAAoF;AACpF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiB7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACnE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBAEhC,CAAA;AACF,eAAO,MAAM,oBAAoB;;;;;iBAE/B,CAAA;AAEF,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;kBAOzB,CAAA;AACX,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,yFAAyF;AACzF,eAAO,MAAM,+BAA+B;;;;kBAMjC,CAAA;AACX,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,sGAAsG;AACtG,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;iBAM/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACvE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,qGAAqG;AACrG,8BAAsB,sBAAsB;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,CACrB,IAAI,CAAC,EAAE,+BAA+B,GACrC,eAAe,CAAC,qBAAqB,EAAE,CAAC;IAC3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,MAAM,CACb,IAAI,CAAC,EAAE,uBAAuB,GAC7B,eAAe,CAAC,yBAAyB,CAAC;IAC7C,sGAAsG;IACtG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,kBAAkB,EAAE,CAAC;IAC9E,kHAAkH;IAClH,QAAQ,CAAC,GAAG,CACV,SAAS,EAAE,sBAAsB,GAChC,eAAe,CAAC,kBAAkB,GAAG,IAAI,CAAC;CAC9C"}

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"}