@snaptrude/plugin-core 0.9.14 → 0.9.16-networks-20261008.1

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

@@ -1,6 +1,7 @@
 import * as z from "zod";
 import { PluginApiReturn } from "../../types";
 import { BrepHandle, ComponentHandle } from "../../handles";
+import { NetworkFamilyContract } from "./networks";
 /**
  * `snaptrude.design.family.*` — author NATIVE parametric families from a JSON spec.
  *
@@ -11,19 +12,36 @@ import { BrepHandle, ComponentHandle } from "../../handles";
  * compiles that into a live parametric definition the user can place, flex and
  * save to their library.
  *
- * ## Workflow
+ * ## Generic component workflow
  *
  * ```
- * getReference()        read the spec DSL once — grammar, ops, expressions, example
- * prepare({ bundle })   validate + compile + show a live ghost; nothing committed
+ * getReference()        read the spec DSL once — grammar, ops, expressions, examples
+ * getExamples()         worked example families by discipline; getExamples({ id }) for one
+ * prepare({ bundle })   validate + compile; nothing committed, nothing in the viewport
  * flex({ values })      re-run at new values; returns the geometry delta
  * place({ position })   put it in the model — saves the family as the first instance drops
  * place()               save the family, then arm placement — the USER clicks to drop it
+ * create()              save an EDIT of a saved family — the app asks the user
  * create({ teamId })    share with a team; a save with nothing placed also drops one instance
  * ```
  *
  * `place` saves the prepared family to the user's personal library, so it
- * survives reload with no extra step; finish on `place`, not on `create`.
+ * survives reload with no extra step; finish a NEW generic component on
+ * `place`, not on `create` (`create` ends only an edit of a saved family, below).
+ *
+ * For architectural families, use `create({ name })` to save the prepared recipe.
+ * Read `design.catalog` and pass the saved `{ id, version }` reference to the
+ * native `design.create` method with its contour, wall profile, or straight axis.
+ * Standalone placement does not create a native host. Selecting a Draw type
+ * does not register an API type. Native creator values use mm, while this
+ * generic family API uses SU. Read `family_authoring` for the full workflow.
+ *
+ * ## Changing a saved family
+ *
+ * Open it with `get({ id })` or `get({ component })`, edit with `prepare` /
+ * `flex`, then `create()`. The app — not the agent — asks the user whether to
+ * update that family (this project's placed copies move to the new version) or
+ * save a new family. Do not ask this yourself; report the returned `decision`.
  *
  * ## Read getReference() first
  *
@@ -81,6 +99,28 @@ export declare abstract class PluginDesignFamilyApi {
      * ```
      */
     abstract getReference(): PluginApiReturn<PluginFamilyReference>;
+    /**
+     * Worked example families to learn from: real, tested bundles by discipline
+     * (architecture, structure, MEP, furniture). With no `id`, returns the
+     * catalogue — each example's id, label, discipline and the patterns it
+     * teaches — filtered by `discipline` / `tag` when given. With an `id`,
+     * returns that example's full bundle. Fetch the one closest to the task
+     * before authoring and borrow its patterns; examples are patterns to
+     * combine, not templates to copy whole.
+     *
+     * @param args - `{ id }` for one bundle, or `{ discipline?, tag? }` to list
+     * @returns The catalogue, or one example with its bundle
+     *
+     * @examplePrompt Show me an example of a structural family
+     * @examplePrompt How is a hosted door family written?
+     *
+     * # Example
+     * ```ts
+     * const list = await snaptrude.design.family.getExamples({ discipline: "mep" })
+     * const ex = await snaptrude.design.family.getExamples({ id: list[0].id })
+     * ```
+     */
+    abstract getExamples(args?: PluginDesignFamilyGetExamplesArgs): PluginApiReturn<PluginFamilyExampleSummary[] | PluginFamilyExample>;
     /**
      * Validate, compile and preview a family spec. Nothing is committed to the
      * model or the library — call {@linkcode PluginDesignFamilyApi.place} to put
@@ -132,16 +172,36 @@ export declare abstract class PluginDesignFamilyApi {
      */
     abstract flex(args: PluginDesignFamilyFlexArgs): PluginApiReturn<PluginFamilyFlexResult>;
     /**
-     * The prepared family's spec bundle, or `null` when nothing is prepared.
+     * A family's spec bundle: the prepared draft's, or — to CHANGE a saved
+     * family — that family's recipe, opened as the new draft.
+     *
+     * - No arguments: the prepared draft, or `null` when nothing is prepared.
+     * - `{ id, version? }`: open a saved family from the library (newest version
+     *   when `version` is omitted).
+     * - `{ component }`: open the family (at its version) of that placed copy.
+     *
+     * Opening makes the recipe the current draft and returns `editing` — which
+     * saved family it is. Edit it with `prepare` / `flex`, then call `create`.
+     * On that save the APP shows the user its own window asking whether to
+     * update the family (every placed copy in this project moves to the new
+     * version) or save it as a new family — "new family" is the default. Never
+     * ask the user this yourself, and never promise either outcome: report what
+     * `create` returns.
      *
-     * @returns The draft bundle, or `null`
+     * @param args Optional: which saved family to open
+     * @returns The bundle (plus `editing` when it edits a saved family), or `null`
+     *
+     * @examplePrompt Make the chairs I placed 50 mm wider
+     * @examplePrompt Change the Louvre Screen family so its blades are deeper
      *
      * # Example
      * ```ts
-     * const bundle = await snaptrude.design.family.get()
+     * const draft = await snaptrude.design.family.get()
+     * const family = await snaptrude.design.family.get({ component })
+     * // family.editing → { familyId, version, name, library }
      * ```
      */
-    abstract get(): PluginApiReturn<PluginFamilyBundle | null>;
+    abstract get(args?: PluginDesignFamilyGetArgs): PluginApiReturn<PluginFamilyGetResult | null>;
     /**
      * Every parametric family registered in this session — native and imported.
      *
@@ -155,6 +215,23 @@ export declare abstract class PluginDesignFamilyApi {
      * ```
      */
     abstract list(): PluginApiReturn<PluginFamilySummary[]>;
+    /**
+     * Read one saved catalog definition without opening a draft or placing geometry.
+     * Both id and version are required. The catalog checks access on every read.
+     * Length defaults and bounds are in mm, ready for network graph overrides;
+     * angle parameters retain degrees, identified by each parameter's unit.
+     * existing getParameters/place/setParameters continue to use Snaptrude units.
+     * Defaults include current catalog overrides, which can change without a new version.
+     * No scene, registry, history, or persistence state is changed.
+     * Missing/inaccessible pins and invalid recipes fail; no latest-version fallback.
+     * This metadata does not certify connectors or engineering compatibility.
+     *
+     * @param args Exact saved catalog id and version, from list()
+     * @returns Compact parameter metadata, not geometry or the recipe bundle
+     * @example
+     * const definition = await snaptrude.design.family.getDefinition({ id, version })
+     */
+    abstract getDefinition(args: PluginDesignFamilyGetDefinitionArgs): PluginApiReturn<PluginFamilyDefinition>;
     /**
      * Put a family into the model — either the prepared draft or any family from
      * {@linkcode PluginDesignFamilyApi.list}.
@@ -177,6 +254,13 @@ export declare abstract class PluginDesignFamilyApi {
      * To COPY a placed component, place its family again at the new position with
      * the same `values` — there is no separate copy call.
      *
+     * HOSTED families (doors, windows — anything with an `opening`, a `host`
+     * block, or a void with `cuts: "host"`) take `host`: a wall or a placed
+     * family. The family is set into the host's face nearest `position` (the
+     * host's middle when omitted), and the host is cut — a system wall by the
+     * wall cutter, a family by its own recipe. Host-bound parameters then follow
+     * the host (a door's wall thickness follows the wall).
+     *
      * @param args Which family, where, and at what parameter values
      * @returns What was placed; `component` is present only in positioned mode
      *
@@ -196,6 +280,9 @@ export declare abstract class PluginDesignFamilyApi {
      *
      * // interactive — the user clicks
      * await snaptrude.design.family.place()
+     *
+     * // hosted — a door in a wall, near a point along it
+     * await snaptrude.design.family.place({ id: doorId, host: wall, position: { x: 3, y: 0, z: 0 } })
      * ```
      */
     abstract place(args?: PluginDesignFamilyPlaceArgs): PluginApiReturn<PluginFamilyPlaceResult>;
@@ -232,6 +319,34 @@ export declare abstract class PluginDesignFamilyApi {
      * that does not is accepted and stored (it round-trips to Revit) but nothing
      * visible happens — say so rather than claiming a change the user cannot see.
      *
+     * NESTED children: `children: { "<path>": { key: value } }` sets a nested
+     * child's own values (every copy of it). A value its parent sets is sent up
+     * to what it follows when that is a plain relationship; otherwise it is
+     * refused with what to change instead (see `refused`).
+     *
+     * LINKS: `links: { key: { from, expr } }` makes this family's `key` follow
+     * another placed object — `from` is a family (it reports its parameters and
+     * outputs) or a wall (it reports thickness, length, height); `expr` is an
+     * expression over those reports. `null` removes a link. Links that would
+     * make objects follow each other in a loop are refused. Values accept unit
+     * literals ("600mm").
+     *
+     * RELATIONS: `relations: { add: [...], remove: ["r1"] }` sets how the family
+     * sits against other placed objects or cuts its host:
+     * - `attach` — `{ kind: "attach", side: "base" | "top", to: <object> | { level, face? }, offset? }`:
+     *   sits on a surface, or its top reaches one (reports `reach`, `gap`, `surface`).
+     * - `join` — `{ kind: "join", end, to: <family>, toEnd, bindOther? }`: its end moves onto
+     *   the other's end (reports `angle`, `absAngle`, `mitre`).
+     * - `span` — `{ kind: "span", from, to, at? }`: pinned between two objects, running along
+     *   its +X (reports `distance`, `run`, `rise`, `slope`, `from.*`, `to.*`).
+     * - `path` — `{ kind: "path", from? | points, closed? }`: follows a wall's centreline, a
+     *   family's run or given points (reports `length`; the recipe reads the path).
+     * - `cut` — `{ kind: "cut", to: "host" }`: applies recipe voids to the current host.
+     *   Removing it closes the opening without detaching or deleting the family.
+     *   Door/window placement adds it. Hosting alone does not cut. No parameter binds.
+     * Placement relations take `bind: { <param>: "<expression over its reports>" }`; bound
+     * parameters are read-only. A relation with an existing `id` replaces it.
+     *
      * `length` values are Snaptrude units: the same 254 mm unit as the kernel's
      * internal (`"babylon"`) unit — convert the user's number with
      * `core.units.convert` first; a bare `400` is 400 SU, not 400 mm. Kernel part
@@ -246,6 +361,15 @@ export declare abstract class PluginDesignFamilyApi {
      * # Example
      * ```ts
      * await snaptrude.design.family.setParameters({ component, values: { seats: 8 } })
+     * await snaptrude.design.family.setParameters({ component, children: { chair: { width: "380mm" } } })
+     * await snaptrude.design.family.setParameters({
+     *   component: railing,
+     *   links: { steps: { from: stair, expr: "steps" }, side: { from: stair, expr: "width - 40mm" } },
+     * })
+     * await snaptrude.design.family.setParameters({
+     *   component: post,
+     *   relations: { add: [{ kind: "attach", side: "top", to: slab, bind: { height: "reach" } }] },
+     * })
      * ```
      */
     abstract setParameters(args: PluginDesignFamilySetParametersArgs): PluginApiReturn<PluginFamilyInstanceParameters>;
@@ -256,8 +380,17 @@ export declare abstract class PluginDesignFamilyApi {
      * in the model yet, one instance is also dropped at the centre of the current
      * view on the active storey (`placed: true`), so a save is never invisible.
      *
+     * When the draft edits a saved family (opened with `get({ id })` /
+     * `get({ component })`), or its name is already taken in that library, the
+     * APP asks the user in its own window whether to save a new version of that
+     * family — every placed copy in this project moves to it, and families
+     * nesting it may be offered theirs — or a new family ("new family" is the
+     * default). The agent never asks this itself and cannot answer the window.
+     * `decision` reports what the user chose; `"cancelled"` means nothing was
+     * saved (`ok: false`) and nothing will auto-save until `create` is called again.
+     *
      * @param args Optional library name and team scope
-     * @returns The catalogued definition's id and version
+     * @returns The catalogued definition's id and version, and what the user chose
      *
      * @examplePrompt Save this as a family called Vertical Louvre
      * @examplePrompt Add it to my library
@@ -292,6 +425,20 @@ export declare abstract class PluginDesignFamilyApi {
      */
     abstract delete(args?: PluginDesignFamilyDeleteArgs): PluginApiReturn<PluginFamilyDeleteResult>;
 }
+/** One worked example in the catalogue returned by `getExamples`. */
+export interface PluginFamilyExampleSummary {
+    id: string;
+    label: string;
+    discipline: "architecture" | "structure" | "mep" | "furniture";
+    /** The patterns it demonstrates, e.g. "nesting", "slot", "path", "union", "trim". */
+    teaches: string[];
+    /** Size of the bundle as compact JSON, kilobytes — what fetching it costs. */
+    sizeKB: number;
+}
+/** One worked example with its full bundle, from `getExamples({ id })`. */
+export interface PluginFamilyExample extends PluginFamilyExampleSummary {
+    bundle: PluginFamilyBundle;
+}
 /** The family-spec DSL reference returned by `getReference`. */
 export interface PluginFamilyReference {
     /** Grammar, op table, expression whitelist, repair contract, worked example. */
@@ -309,6 +456,31 @@ export interface PluginFamilyReference {
 export interface PluginFamilyBundle {
     root: Record<string, unknown>;
     deps?: Record<string, Record<string, unknown>>;
+    /** Connector metadata saved with the recipe; network placement evaluates these expressions. */
+    network?: NetworkFamilyContract;
+}
+/** Which saved family a draft edits. */
+export interface PluginFamilyEditing {
+    /** Library id of the family being edited. */
+    familyId: string;
+    /** The version that was opened. */
+    version: number;
+    /** Its library name — an update saves under this name. */
+    name: string;
+    /** "your library", or the team library's name. */
+    library: string;
+}
+/** What `get` returns: the bundle, plus `editing` when the draft edits a saved family. */
+export interface PluginFamilyGetResult extends PluginFamilyBundle {
+    editing?: PluginFamilyEditing;
+}
+/** A family at a version, as `create` reports parents it did or did not update. */
+export interface PluginFamilyVersionRef {
+    id: string;
+    name: string;
+    version: number;
+    /** Set when the user chose to update it but the update failed. */
+    error?: string;
 }
 /** Axis-aligned extents of a built family. Snaptrude units (1 SU = 254 mm), +Y up. */
 export interface PluginFamilyBBox {
@@ -342,7 +514,11 @@ export interface PluginFamilyParameter {
 export interface PluginFamilyDiagnostic {
     /** JSON pointer, e.g. `"/root/geometry/2/body/0/w"`. */
     path: string;
-    code: "schema" | "bad-expression" | "unknown-name" | "unknown-def" | "cycle" | "duplicate-name" | "unbounded-repeat" | "depth" | "bad-dimension" | "proportion";
+    code: "schema" | "bad-expression" | "unknown-name" | "unknown-def" | "cycle" | "duplicate-name" | "unbounded-repeat" | "depth" | "bad-dimension" | "proportion"
+    /** A part the geometry kernel could not build exactly; drawn approximately. */
+     | "kernel-fallback"
+    /** A part whose hole loop crosses its outline. */
+     | "profile-hole";
     message: string;
     hint?: string;
 }
@@ -437,6 +613,93 @@ export interface PluginFamilySummary {
      */
     kind: "native" | "revit";
 }
+/** Exact catalog pin. Unsaved session definitions are not catalog inventory. */
+export declare const PluginDesignFamilyGetDefinitionArgs: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginDesignFamilyGetDefinitionArgs = z.infer<typeof PluginDesignFamilyGetDefinitionArgs>;
+/** Saved-family metadata. Physical lengths use mm; angle entries retain degrees. */
+export declare const PluginFamilyDefinitionParameter: 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>;
+export type PluginFamilyDefinitionParameter = z.infer<typeof PluginFamilyDefinitionParameter>;
+/** Read-only catalog inventory. Boolean defaults retain the family DSL's Yes/No strings. */
+export declare const PluginFamilyDefinition: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+    label: z.ZodString;
+    category: z.ZodOptional<z.ZodString>;
+    lengthUnit: z.ZodLiteral<"mm">;
+    parameters: 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>>;
+    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>;
+export type PluginFamilyDefinition = z.infer<typeof PluginFamilyDefinition>;
 /** What `place` reports. */
 export interface PluginFamilyPlaceResult {
     ok: boolean;
@@ -464,6 +727,108 @@ export interface PluginFamilyInstanceParameters {
     parts?: PluginFamilyPart[];
     /** Present when `getParameters` was asked for a `snapshot`. */
     snapshot?: PluginFamilySnapshot;
+    /** The family's `outputs`, as last built. */
+    reports?: Record<string, number | string>;
+    /** Every declared nested child, as last built. */
+    children?: PluginFamilyNestedChild[];
+    /** Parameters that follow another object (links) or the host. */
+    follows?: PluginFamilyFollow[];
+    /** Where a hosted family sits: a system wall, or a family by id. */
+    host?: ({
+        kind: "wall";
+    } | {
+        kind: "family";
+        id: string;
+    }) & {
+        /** True when the host no longer has room for it: it is out of the model until it fits again. */
+        parked?: boolean;
+    };
+    /** Guests hosted in THIS family that no longer fit it (parked); they return when they fit. */
+    parkedGuests?: {
+        id: string;
+        family: string;
+    }[];
+    /** How it sits against other placed objects (attach, join, span, path), with current reports. */
+    relations?: PluginFamilyRelation[];
+    /** setParameters only: the edits refused, each with what to change instead. */
+    refused?: string[];
+}
+/** A nested child of a placed family. */
+export interface PluginFamilyNestedChild {
+    /** "chair", or "chair/cushion" for a child of a child — the key for `children` edits. */
+    path: string;
+    label: string;
+    /** The family it is now (a slot's current pick). */
+    family: string;
+    familyLabel: string;
+    /** How many copies the parent places. */
+    copies: number;
+    slot?: {
+        expr: string;
+        options: string[];
+    };
+    values: Record<string, number | string>;
+    /** Values the parent sets, with the expression it sets them by. */
+    setBy: Record<string, string | undefined>;
+    reports: Record<string, number | string>;
+}
+/** A placed relation as stored, plus what it measures now. */
+export type PluginFamilyRelation = PluginFamilyRelationInput & {
+    id: string;
+    /** "Attached to", "Joins", "Spans between", "Along a path", "Cuts host". */
+    label: string;
+    summary: string;
+    /** False when a target is gone: the family stayed where it was. */
+    live: boolean;
+    reports: Record<string, number | string>;
+};
+/** One relation to add (`relations.add`). Targets are handles, except a cut's symbolic "host". */
+export type PluginFamilyRelationInput = {
+    /** Replaces the relation with this id; a new one gets "r1", "r2"… */
+    id?: string;
+    /** This family's parameter → an expression over the relation's reports and own parameters. */
+    bind?: Record<string, string>;
+} & ({
+    kind: "attach";
+    side: "base" | "top";
+    to: ComponentHandle | {
+        level: number;
+        face?: "base" | "top";
+    };
+    offset?: number;
+} | {
+    kind: "join";
+    end: "start" | "end";
+    to: ComponentHandle;
+    toEnd: "start" | "end";
+    /** The other family's parameters, over the same reports. */
+    bindOther?: Record<string, string>;
+} | {
+    kind: "span";
+    from: ComponentHandle;
+    to: ComponentHandle;
+    at?: "top" | "centre" | "base";
+} | {
+    kind: "path";
+    from?: ComponentHandle;
+    points?: [number, number, number][];
+    closed?: boolean;
+} | {
+    /** Apply recipe voids to the existing host without adding another host ID. */
+    kind: "cut";
+    to: "host";
+    bind?: never;
+});
+/** One parameter that follows something else. */
+export interface PluginFamilyFollow {
+    key: string;
+    /** "relation": set by a placed relation — `from` is the relation's id. */
+    kind: "link" | "host" | "relation";
+    /** The source's id. */
+    from: string;
+    fromLabel: string;
+    /** The expression over the source's reports (for a host: the report name). */
+    expr: string;
 }
 /** What `create` reports. */
 export interface PluginFamilyCreateResult {
@@ -475,6 +840,36 @@ export interface PluginFamilyCreateResult {
     placed?: boolean;
     /** Host guidance for the caller, e.g. that an instance was placed at the view centre. */
     hint?: string;
+    /**
+     * What the user chose in the app's window: `"version"` (a new version of
+     * the saved family), `"new"` (a new family), `"cancelled"` (nothing saved).
+     * `"saved"` = no question was needed.
+     */
+    decision?: "version" | "new" | "cancelled" | "saved";
+    /** The library name it was saved under. */
+    name?: string;
+    /** Placed copies in this project moved to the new version (the family's and updated parents'). */
+    movedCopies?: number;
+    /** What the moved copies lost because the new version no longer has it. */
+    dropped?: {
+        values: Array<{
+            copy: string;
+            key: string;
+        }>;
+        childValues: Array<{
+            copy: string;
+            path: string;
+        }>;
+        follows: Array<{
+            copy: string;
+            key: string;
+            kind: "link" | "relation";
+        }>;
+    };
+    /** Families nesting this one that the user chose to update, at their new versions. */
+    parentsUpdated?: PluginFamilyVersionRef[];
+    /** Families nesting this one that keep their version. */
+    parentsKept?: PluginFamilyVersionRef[];
     error?: string;
 }
 /** What `delete` reports. */
@@ -497,6 +892,30 @@ export interface PluginFamilyDeleteResult {
 export declare const PluginFamilyBundleSchema: 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>;
 /**
  * Arguments for {@linkcode PluginDesignFamilyApi.prepare}.
@@ -517,7 +936,24 @@ export declare const PluginFamilyBundleSchema: z.ZodObject<{
  * the viewport is not moved — and comes back as a PNG data URL in the result's
  * `snapshot.image`. Through the agent's `run_worker`, return the result and the
  * image reaches the model as an image.
+ *
+ * `focus` makes it a close-up: `{ parts: ["seat", "back", "slat@*"] }` frames
+ * those parts (`*` matches any run of characters; nested names are `a/b`) with
+ * a margin of a quarter of their size (at least 50 mm), so a joint is "the two
+ * parts that meet"; `{ box: { min, max } }` frames a region in family space
+ * (Snaptrude units, +Y up). Every other part is still drawn; the dimension line
+ * then gives the framed region and the result says `closeUp: true`. A part
+ * name that matches nothing fails the snapshot with a list of real names.
  */
+export declare const PluginFamilySnapshotFocus: z.ZodUnion<readonly [z.ZodObject<{
+    parts: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    box: z.ZodObject<{
+        min: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+        max: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+    }, z.core.$strip>;
+}, z.core.$strip>]>;
+export type PluginFamilySnapshotFocus = z.infer<typeof PluginFamilySnapshotFocus>;
 export declare const PluginFamilySnapshotOption: z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
     views: z.ZodOptional<z.ZodArray<z.ZodEnum<{
         top: "top";
@@ -526,6 +962,14 @@ export declare const PluginFamilySnapshotOption: z.ZodUnion<readonly [z.ZodBoole
         iso: "iso";
     }>>>;
     tileSize: z.ZodOptional<z.ZodNumber>;
+    focus: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        parts: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        box: z.ZodObject<{
+            min: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+            max: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+        }, z.core.$strip>;
+    }, z.core.$strip>]>>;
 }, z.core.$strip>]>;
 export type PluginFamilySnapshotOption = z.infer<typeof PluginFamilySnapshotOption>;
 /** The picture block on prepare / flex / getParameters results when `snapshot` was asked for. */
@@ -534,9 +978,11 @@ export interface PluginFamilySnapshot {
     /** PNG data URL of the composed sheet. */
     image?: string;
     views?: ("iso" | "front" | "right" | "top")[];
-    /** [width, height, depth] in Snaptrude units. */
+    /** [width, height, depth] in Snaptrude units — of the framed region when `closeUp`. */
     size?: [number, number, number];
     ms?: number;
+    /** True when the sheet is a close-up (`focus`), not the whole family. */
+    closeUp?: boolean;
     /** Set when the picture could not be taken (e.g. the legacy renderer); the call itself still succeeded. */
     error?: string;
 }
@@ -544,10 +990,58 @@ export declare const PluginDesignFamilyPrepareArgs: z.ZodObject<{
     bundle: 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>>;
     spec: 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>>;
     snapshot: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
         views: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -557,6 +1051,14 @@ export declare const PluginDesignFamilyPrepareArgs: z.ZodObject<{
             iso: "iso";
         }>>>;
         tileSize: z.ZodOptional<z.ZodNumber>;
+        focus: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            parts: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            box: z.ZodObject<{
+                min: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+                max: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+            }, z.core.$strip>;
+        }, z.core.$strip>]>>;
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
 export type PluginDesignFamilyPrepareArgs = z.infer<typeof PluginDesignFamilyPrepareArgs>;
@@ -578,9 +1080,53 @@ export declare const PluginDesignFamilyFlexArgs: z.ZodObject<{
             iso: "iso";
         }>>>;
         tileSize: z.ZodOptional<z.ZodNumber>;
+        focus: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            parts: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            box: z.ZodObject<{
+                min: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+                max: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+            }, z.core.$strip>;
+        }, z.core.$strip>]>>;
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
 export type PluginDesignFamilyFlexArgs = z.infer<typeof PluginDesignFamilyFlexArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignFamilyApi.get}. All optional — no
+ * arguments returns the prepared draft.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | A saved family to open for editing, from {@linkcode PluginDesignFamilyApi.list} |
+ * | `version` | `number` | Exact version to open; defaults to the newest |
+ * | `component` | {@linkcode ComponentHandle} | Open the family of this placed copy, at its version |
+ */
+export declare const PluginDesignFamilyGetArgs: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodNumber>;
+    component: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignFamilyGetArgs = z.infer<typeof PluginDesignFamilyGetArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignFamilyApi.getExamples}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | One example's id — returns its bundle |
+ * | `discipline` | `string` | List only this discipline: architecture, structure, mep, furniture |
+ * | `tag` | `string` | List only examples teaching this pattern (e.g. "path", "union") |
+ */
+export declare const PluginDesignFamilyGetExamplesArgs: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    discipline: z.ZodOptional<z.ZodEnum<{
+        architecture: "architecture";
+        structure: "structure";
+        mep: "mep";
+        furniture: "furniture";
+    }>>;
+    tag: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PluginDesignFamilyGetExamplesArgs = z.infer<typeof PluginDesignFamilyGetExamplesArgs>;
 /**
  * Arguments for {@linkcode PluginDesignFamilyApi.create}.
  *
@@ -630,6 +1176,7 @@ export declare const PluginDesignFamilyPlaceArgs: z.ZodObject<{
     rotation: z.ZodOptional<z.ZodNumber>;
     values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
     storey: z.ZodOptional<z.ZodNumber>;
+    host: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
 }, z.core.$strip>;
 export type PluginDesignFamilyPlaceArgs = z.infer<typeof PluginDesignFamilyPlaceArgs>;
 /**
@@ -649,6 +1196,14 @@ export declare const PluginDesignFamilyGetParametersArgs: z.ZodObject<{
             iso: "iso";
         }>>>;
         tileSize: z.ZodOptional<z.ZodNumber>;
+        focus: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            parts: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            box: z.ZodObject<{
+                min: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+                max: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
+            }, z.core.$strip>;
+        }, z.core.$strip>]>>;
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
 export type PluginDesignFamilyGetParametersArgs = z.infer<typeof PluginDesignFamilyGetParametersArgs>;
@@ -662,7 +1217,16 @@ export type PluginDesignFamilyGetParametersArgs = z.infer<typeof PluginDesignFam
  */
 export declare const PluginDesignFamilySetParametersArgs: z.ZodObject<{
     component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
-    values: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    values: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>>;
+    children: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>>;
+    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+        from: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+        expr: z.ZodString;
+    }, z.core.$strip>, z.ZodNull]>>>;
+    relations: z.ZodOptional<z.ZodObject<{
+        add: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+        remove: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export type PluginDesignFamilySetParametersArgs = z.infer<typeof PluginDesignFamilySetParametersArgs>;
 //# sourceMappingURL=family.d.ts.map