@snaptrude/plugin-core 0.0.0-dev-20260708130115 → 0.0.0-dev-20260827135706

package/src/api/core/geom/delete/index.ts

@@ -20,6 +20,9 @@ export abstract class PluginGeomDeleteApi {
    * reclaims its share of the plugin's resource quota. This is a handle-lifecycle
    * operation only and does NOT tear down any engine-side geometry.
    *
+   * @deprecated Use `core.handles.release([profile])` — the universal, batched
+   * release API for every arena handle kind.
+   *
    * @param profile The transient profile handle to release
    * @returns Nothing
    *
@@ -37,6 +40,9 @@ export abstract class PluginGeomDeleteApi {
    * reclaims its share of the plugin's resource quota. Handle-lifecycle only; does
    * NOT tear down engine-side geometry, nor the contour's child profile handles.
    *
+   * @deprecated Use `core.handles.release([contour])` — the universal, batched
+   * release API for every arena handle kind.
+   *
    * @param contour The transient contour handle to release
    * @returns Nothing
    *

package/src/api/core/geom/query/brep.ts

@@ -163,6 +163,64 @@ export abstract class PluginGeomQueryBrepApi {
     vertexIndexB: number
   ): PluginApiReturn<EdgeHandle[]>
 
+  /**
+   * Read the exact curve of a brep edge as plain values — a discriminated
+   * union on `type`. Pure read: no geometry kernel is loaded. Points and
+   * directions are {@linkcode Vec3Components}; lengths and radii are raw
+   * Babylon units.
+   *
+   * | `type` | Fields |
+   * |---|---|
+   * | `"line"` | `startPoint`, `endPoint`, `length` |
+   * | `"arc"` | `startPoint`, `endPoint`, `centre`, `axis`, `radius`, `length` |
+   * | `"circle"` | `centre`, `axis`, `radius`, `length` — a full-circle edge (e.g. a cylinder cap rim) |
+   *
+   * @param brep The brep the edge belongs to
+   * @param edge The edge whose curve to read
+   * @returns The curve data as a discriminated union on `type` (see table above)
+   * @throws VALIDATION if the edge is not on `brep`
+   *
+   * @examplePrompt Read the radius of this curved edge
+   * @examplePrompt Is this edge straight or an arc?
+   * @examplePrompt Get the exact start and end points of this edge
+   * @examplePrompt Measure the length of each edge of this mass
+   *
+   * # Example
+   * ```ts
+   * const [mass] = await snaptrude.design.query.listMasses()
+   * const brep = await snaptrude.design.query.geometry.getBrep(mass)
+   * if (brep) {
+   *   const edges = await snaptrude.core.geom.query.brep.listEdges(brep)
+   *   for (const edge of edges) {
+   *     const curve = await snaptrude.core.geom.query.brep.getEdgeCurve(brep, edge)
+   *     if (curve.type === "arc") console.log("arc radius:", curve.radius)
+   *   }
+   * }
+   * ```
+   */
+  public abstract getEdgeCurve(
+    brep: BrepHandle,
+    edge: EdgeHandle
+  ): PluginApiReturn<
+    | { type: "line"; startPoint: Vec3Components; endPoint: Vec3Components; length: number }
+    | {
+        type: "arc"
+        startPoint: Vec3Components
+        endPoint: Vec3Components
+        centre: Vec3Components
+        axis: Vec3Components
+        radius: number
+        length: number
+      }
+    | {
+        type: "circle"
+        centre: Vec3Components
+        axis: Vec3Components
+        radius: number
+        length: number
+      }
+  >
+
   /**
    * Get the position of a vertex within a brep.
    * @param brep The brep to query
@@ -328,6 +386,37 @@ export abstract class PluginGeomQueryBrepApi {
    * ```
    */
   public abstract isEqual(brepA: BrepHandle, brepB: BrepHandle): PluginApiReturn<boolean>
+
+  /**
+   * Measures the minimum distance between two solids, with the closest witness
+   * point on each. Touching or overlapping solids report a distance of 0 with
+   * contact points.
+   *
+   * @param brepA First solid
+   * @param brepB Second solid
+   * @returns `{ distance, pointA, pointB }` — the minimum distance and the
+   *   closest points on `brepA` and `brepB` as {@linkcode Vec3Components}
+   * @throws OPERATION_FAILED if the kernel cannot compute the distance
+   *
+   * @examplePrompt What is the clearance between these two masses?
+   * @examplePrompt How far apart are the tower and the neighbouring building?
+   * @examplePrompt Find the closest points between these two solids
+   *
+   * # Example
+   * ```ts
+   * const [a, b] = await snaptrude.design.query.listMasses()
+   * const brepA = await snaptrude.design.query.geometry.getBrep(a)
+   * const brepB = await snaptrude.design.query.geometry.getBrep(b)
+   * if (brepA && brepB) {
+   *   const { distance, pointA, pointB } = await snaptrude.core.geom.query.brep.getDistance(brepA, brepB)
+   *   console.log("clearance:", distance)
+   * }
+   * ```
+   */
+  public abstract getDistance(
+    brepA: BrepHandle,
+    brepB: BrepHandle
+  ): PluginApiReturn<{ distance: number; pointA: Vec3Components; pointB: Vec3Components }>
 }
 
 const brepArg = z.object({ brep: BrepHandle })
@@ -377,6 +466,22 @@ export type PluginGeomQueryBrepListEdgesBetweenArgs = z.infer<
   typeof PluginGeomQueryBrepListEdgesBetweenArgs
 >
 
+/**
+ * Arguments for {@linkcode PluginGeomQueryBrepApi.getEdgeCurve}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `brep` | {@linkcode BrepHandle} | The brep the edge belongs to |
+ * | `edge` | {@linkcode EdgeHandle} | The edge whose curve to read |
+ */
+export const PluginGeomQueryBrepGetEdgeCurveArgs = z.object({
+  brep: BrepHandle,
+  edge: EdgeHandle,
+})
+export type PluginGeomQueryBrepGetEdgeCurveArgs = z.infer<
+  typeof PluginGeomQueryBrepGetEdgeCurveArgs
+>
+
 /**
  * Arguments for {@linkcode PluginGeomQueryBrepApi.getVertexPosition}.
  *
@@ -442,3 +547,17 @@ export const PluginGeomQueryBrepIsEqualArgs = z.object({
   brepB: BrepHandle,
 })
 export type PluginGeomQueryBrepIsEqualArgs = z.infer<typeof PluginGeomQueryBrepIsEqualArgs>
+
+/**
+ * Arguments for {@linkcode PluginGeomQueryBrepApi.getDistance}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `brepA` | {@linkcode BrepHandle} | First solid |
+ * | `brepB` | {@linkcode BrepHandle} | Second solid |
+ */
+export const PluginGeomQueryBrepGetDistanceArgs = z.object({
+  brepA: BrepHandle,
+  brepB: BrepHandle,
+})
+export type PluginGeomQueryBrepGetDistanceArgs = z.infer<typeof PluginGeomQueryBrepGetDistanceArgs>

package/src/api/core/handles/index.ts

@@ -0,0 +1,233 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../../types"
+// Type-only: src/handles.ts type-only-imports ArenaKind from this file, so the
+// cycle stays purely type-level and is erased at emit.
+import type { AnyArenaHandle } from "../../../handles"
+import { Handle } from "../../../handles"
+
+/**
+ * The 12 registry-arena handle kinds — the releasable families. Entity-style
+ * handles (component / material / underlay / terrain / importJob / comment) are
+ * raw engine ids with no arena entry and therefore no lifecycle: passing one to
+ * `release` is a silent no-op like any other unknown id.
+ */
+export const ArenaKind = z.enum([
+  "vec3",
+  "quat",
+  "line",
+  "arc",
+  "circle",
+  "profile",
+  "contour",
+  "brep",
+  "face",
+  "edge",
+  "halfedge",
+  "vertex",
+])
+export type ArenaKind = z.infer<typeof ArenaKind>
+
+/** Max handles accepted by a single `release` / `endScope(retain)` call. */
+export const RELEASE_BATCH_MAX = 10_000
+
+/**
+ * An opaque token identifying a handle scope opened by
+ * {@linkcode PluginCoreHandlesApi.beginScope}. It is NOT an arena handle —
+ * it pins no memory, and `release(token)` is a silent no-op; only
+ * {@linkcode PluginCoreHandlesApi.endScope} consumes it.
+ */
+export type ScopeToken = string
+
+/**
+ * Handle lifecycle — free host-side handle registry entries the plugin no
+ * longer needs, individually ({@linkcode release}), by kind
+ * ({@linkcode releaseAll}), or as a mint-recording region
+ * ({@linkcode beginScope} / {@linkcode endScope}).
+ *
+ * Releasing is a handle-lifecycle operation only: it frees the registry entry
+ * (host memory + quota room) and makes the handle unresolvable. It never
+ * deletes engine-side geometry or scene entities.
+ *
+ * Accessed via `snaptrude.core.handles`.
+ */
+export abstract class PluginCoreHandlesApi {
+  constructor() {}
+
+  /**
+   * Free arena handles in bulk. Unknown, foreign, or already-released ids are
+   * silent no-ops — there is no per-id result and no count, so responses can
+   * never be used as an existence oracle.
+   *
+   * @param handles The handles to release (max {@linkcode RELEASE_BATCH_MAX} per call)
+   * @returns Nothing
+   *
+   * # Example
+   * ```ts
+   * const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
+   * // ... read what you need ...
+   * await snaptrude.core.handles.release(faces)
+   * ```
+   */
+  public abstract release(handles: ReadonlyArray<AnyArenaHandle>): PluginApiReturn<void>
+
+  /**
+   * Free every live arena handle of one kind, or ALL arena handles when the
+   * kind is omitted. Useful at batch boundaries — e.g. a poll loop that mints
+   * a fresh footprint contour per tick.
+   *
+   * @param kind Optional arena kind to restrict the sweep to
+   * @returns Nothing
+   *
+   * # Example
+   * ```ts
+   * const footprint = await snaptrude.design.query.spaces.getFootprint(space)
+   * // ... measure ...
+   * await snaptrude.core.handles.releaseAll("contour")
+   * ```
+   */
+  public abstract releaseAll(kind?: ArenaKind): PluginApiReturn<void>
+
+  /**
+   * Open a mint-recording scope: every arena handle MINTED after this call
+   * (fresh mints only — identity-deduped re-registrations of pre-existing
+   * objects are not captured) is freed when the matching
+   * {@linkcode endScope} runs. Scopes nest, up to 64 deep — always pair
+   * begin/end in try/finally.
+   *
+   * @returns The scope token to pass to {@linkcode endScope}
+   *
+   * # Example
+   * ```ts
+   * for (const space of spaces) {
+   *   const scope = await snaptrude.core.handles.beginScope()
+   *   try {
+   *     const footprint = await snaptrude.design.query.spaces.getFootprint(space)
+   *     const area = await snaptrude.core.geom.query.contour.getArea(footprint)
+   *   } finally {
+   *     await snaptrude.core.handles.endScope(scope) // footprint (and intermediates) freed
+   *   }
+   * }
+   * ```
+   */
+  public abstract beginScope(): PluginApiReturn<ScopeToken>
+
+  /**
+   * Close a scope by its token and free every handle it recorded, except those
+   * listed in `retain`. Retained handles are promoted to the enclosing scope
+   * (if any), so nesting composes like block scopes. Closing is
+   * token-addressed: an out-of-order close (interleaved async tasks) frees
+   * only that scope's mints and leaves other open scopes intact. Always pair
+   * begin/end in try/finally so a thrown body cannot leak the scope.
+   *
+   * @param scope The token returned by the matching {@linkcode beginScope}
+   * @param retain Handles minted inside the scope that must survive it
+   * @returns Nothing
+   *
+   * # Example
+   * ```ts
+   * const scope = await snaptrude.core.handles.beginScope()
+   * const outline = await snaptrude.design.query.spaces.getFootprint(space)
+   * const outer = await snaptrude.core.geom.query.contour.getOuterProfile(outline)
+   * await snaptrude.core.handles.endScope(scope, [outer]) // outline freed, outer survives
+   * ```
+   */
+  public abstract endScope(
+    scope: ScopeToken,
+    retain?: ReadonlyArray<AnyArenaHandle>
+  ): PluginApiReturn<void>
+
+  /**
+   * Live handle-registry statistics for the calling plugin, plus the host
+   * page's JS heap usage (when the browser exposes it). Diagnostic surface for
+   * verifying that releases actually shrink host memory.
+   *
+   * @returns Arena entry counts, open scope depth, and host heap bytes
+   *
+   * # Example
+   * ```ts
+   * const before = await snaptrude.core.handles.stats()
+   * await snaptrude.core.handles.releaseAll("vec3")
+   * const after = await snaptrude.core.handles.stats()
+   * console.log(`freed ${before.values - after.values} value entries`)
+   * ```
+   */
+  public abstract stats(): PluginApiReturn<PluginHandlesStatsResult>
+}
+
+/**
+ * Wire-normalize one handle argument: a raw id string passes through; a live
+ * `Handle` instance (direct host callers — console harness, host-internal) or a
+ * structured-clone-stripped `{id}` / tagged `{__h}` shape collapses to its id.
+ * Deliberately shape-lax beyond that (non-empty string) — a malformed id is
+ * just an id that resolves nowhere (anti-oracle).
+ */
+const handleIdWire = z.preprocess((v) => {
+  if (typeof v === "string") return v
+  if (v instanceof Handle) return v.id
+  if (v && typeof v === "object") {
+    const o = v as Record<string, unknown>
+    if (typeof o.__h === "string") return o.__h
+    if (typeof o.id === "string") return o.id
+  }
+  return v
+}, z.string().min(1))
+
+/**
+ * Arguments for {@linkcode PluginCoreHandlesApi.release}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `handles` | `string[]` | Handles to release (≤ {@linkcode RELEASE_BATCH_MAX}) |
+ */
+export const PluginHandlesReleaseArgs = z.object({
+  handles: z.array(handleIdWire).max(RELEASE_BATCH_MAX),
+})
+export type PluginHandlesReleaseArgs = z.infer<typeof PluginHandlesReleaseArgs>
+
+/**
+ * Arguments for {@linkcode PluginCoreHandlesApi.releaseAll}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `kind` | {@linkcode ArenaKind} (optional) | Restrict the sweep to one kind |
+ */
+export const PluginHandlesReleaseAllArgs = z.object({
+  kind: ArenaKind.optional(),
+})
+export type PluginHandlesReleaseAllArgs = z.infer<typeof PluginHandlesReleaseAllArgs>
+
+/**
+ * Arguments for {@linkcode PluginCoreHandlesApi.endScope}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `scope` | {@linkcode ScopeToken} | Token from the matching `beginScope` |
+ * | `retain` | `string[]` (optional) | Scope-minted handles that must survive |
+ */
+export const PluginHandlesEndScopeArgs = z.object({
+  scope: z.string().regex(/^scope_[A-Za-z0-9_-]+$/, 'expected a "scope" token'),
+  retain: z.array(handleIdWire).max(RELEASE_BATCH_MAX).optional(),
+})
+export type PluginHandlesEndScopeArgs = z.infer<typeof PluginHandlesEndScopeArgs>
+
+/**
+ * Result of {@linkcode PluginCoreHandlesApi.stats}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `resources` | `number` | Live resource-arena entries (profile/contour) |
+ * | `values` | `number` | Live value-arena entries (vec3/quat/line/arc/circle) |
+ * | `topology` | `number` | Live topology-arena entries (brep/face/edge/halfedge/vertex) |
+ * | `scopes` | `number` | Currently open handle scopes |
+ * | `hostHeapUsedBytes` | `number \| null` | Host page `usedJSHeapSize` (null where unsupported) |
+ * | `hostHeapTotalBytes` | `number \| null` | Host page `totalJSHeapSize` (null where unsupported) |
+ */
+export const PluginHandlesStatsResult = z.object({
+  resources: z.number().int().nonnegative(),
+  values: z.number().int().nonnegative(),
+  topology: z.number().int().nonnegative(),
+  scopes: z.number().int().nonnegative(),
+  hostHeapUsedBytes: z.number().nullable(),
+  hostHeapTotalBytes: z.number().nullable(),
+})
+export type PluginHandlesStatsResult = z.infer<typeof PluginHandlesStatsResult>

package/src/api/core/index.ts

@@ -9,6 +9,13 @@ import { PluginCoreGroupsApi } from "./groups"
 import { PluginCoreBuildingsApi } from "./buildings"
 import { PluginCoreLayersApi } from "./layers"
 import { PluginCoreTagsApi } from "./tags"
+import { PluginCoreIoApi } from "./io"
+import { PluginCoreHandlesApi } from "./handles"
+import { PluginCoreProposalsApi } from "./proposals"
+import { PluginCameraApi } from "./camera"
+import { PluginCoreStoreysApi } from "./storeys"
+import { PluginCoreModeApi } from "./mode"
+import { PluginUserApi } from "./user"
 
 /**
  * Core primitives and infrastructure used across the plugin API.
@@ -18,12 +25,18 @@ import { PluginCoreTagsApi } from "./tags"
  * - {@linkcode PluginCoreApi.history} — Undo / redo of committed history entries
  * - {@linkcode PluginCoreApi.units} — Unit-type queries and conversion
  * - {@linkcode PluginCoreApi.zoom} — Camera zoom controls (extents / selection)
+ * - {@linkcode PluginCoreApi.camera} — Camera controls — position, standard views, 2D/3D mode
+ * - {@linkcode PluginCoreApi.user} — User locale — timezone & language
  * - {@linkcode PluginCoreApi.project} — Project-level settings and info
  * - {@linkcode PluginCoreApi.comment} — Comments: create, edit, resolve, tag, list
  * - {@linkcode PluginCoreApi.groups} — Read & edit the group hierarchy
  * - {@linkcode PluginCoreApi.buildings} — Read & edit buildings and their storeys
+ * - {@linkcode PluginCoreApi.storeys} — Create, read & edit storeys (floors)
  * - {@linkcode PluginCoreApi.layers} — Read & toggle storey drawing/reference layers
  * - {@linkcode PluginCoreApi.tags} — Tag catalog + assignment
+ * - {@linkcode PluginCoreApi.io} — Import files (image/pdf/cad/model/terrain), poll jobs, manage underlays
+ * - {@linkcode PluginCoreApi.handles} — Handle lifecycle: release, releaseAll, scopes
+ * - {@linkcode PluginCoreApi.proposals} — Design options: read, create, rename, switch, delete
  */
 export abstract class PluginCoreApi {
   /** Vector and quaternion math utilities. See {@linkcode PluginMathApi}. */
@@ -36,6 +49,10 @@ export abstract class PluginCoreApi {
   public abstract units: PluginUnitsApi
   /** Camera zoom controls. See {@linkcode PluginZoomApi}. */
   public abstract zoom: PluginZoomApi
+  /** Camera controls — position, standard views, 2D/3D mode. See {@linkcode PluginCameraApi}. */
+  public abstract camera: PluginCameraApi
+  /** User locale — timezone & language. See {@linkcode PluginUserApi}. */
+  public abstract user: PluginUserApi
   /** Project-level settings and info. See {@linkcode PluginProjectApi}. */
   public abstract project: PluginProjectApi
   /** Comments — create, edit, resolve, tag, list. See {@linkcode PluginCommentApi}. */
@@ -44,10 +61,20 @@ export abstract class PluginCoreApi {
   public abstract groups: PluginCoreGroupsApi
   /** Buildings — read & edit buildings and their storeys. See {@linkcode PluginCoreBuildingsApi}. */
   public abstract buildings: PluginCoreBuildingsApi
+  /** Storeys — create, read & edit storeys (floors). See {@linkcode PluginCoreStoreysApi}. */
+  public abstract storeys: PluginCoreStoreysApi
+  /** Application mode — read & switch the editor's top-bar mode. See {@linkcode PluginCoreModeApi}. */
+  public abstract mode: PluginCoreModeApi
   /** Layers — read & toggle storey drawing/reference layers. See {@linkcode PluginCoreLayersApi}. */
   public abstract layers: PluginCoreLayersApi
   /** Tags — tag catalog + assignment. See {@linkcode PluginCoreTagsApi}. */
   public abstract tags: PluginCoreTagsApi
+  /** I/O — file import, import jobs, and underlay management. See {@linkcode PluginCoreIoApi}. */
+  public abstract io: PluginCoreIoApi
+  /** Handle lifecycle — release, releaseAll, and mint-recording scopes. See {@linkcode PluginCoreHandlesApi}. */
+  public abstract handles: PluginCoreHandlesApi
+  /** Proposals — design options: read, create, rename, switch, delete. See {@linkcode PluginCoreProposalsApi}. */
+  public abstract proposals: PluginCoreProposalsApi
 
   constructor() {}
 }
@@ -57,9 +84,16 @@ export * from "./geom"
 export * from "./history"
 export * from "./units"
 export * from "./zoom"
+export * from "./camera"
+export * from "./user"
 export * from "./project"
 export * from "./comment"
 export * from "./groups"
 export * from "./buildings"
+export * from "./storeys"
+export * from "./mode"
 export * from "./layers"
 export * from "./tags"
+export * from "./io"
+export * from "./handles"
+export * from "./proposals"

package/src/api/core/io/export/index.ts

@@ -0,0 +1,126 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../../../types"
+
+/**
+ * Serialization format for {@link PluginCoreIoExportApi.model}.
+ *
+ * `glb` / `obj` serialize in the browser; `fbx` / `3ds` run the same server
+ * conversion the app's Export dialog uses and return a **zip** containing the
+ * converted file.
+ */
+export const ExportModelFormat = z.enum(["glb", "obj", "fbx", "3ds"])
+export type ExportModelFormat = z.infer<typeof ExportModelFormat>
+
+/**
+ * What to export: the whole model (`"scene"`, default) or only the current
+ * selection (`"selection"`).
+ */
+export const ExportScope = z.enum(["scene", "selection"])
+export type ExportScope = z.infer<typeof ExportScope>
+
+/**
+ * A serialized model file returned by {@link PluginCoreIoExportApi.model}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `fileName` | `string` | Suggested file name incl. extension (e.g. `"model.glb"`) |
+ * | `mimeType` | `string` | MIME type (`"model/gltf-binary"` for glb, `"text/plain"` for obj) |
+ * | `dataBase64` | `string` | The file's bytes, base64-encoded (decode to save/download) |
+ */
+export const ExportedFile = z.object({
+  fileName: z.string(),
+  mimeType: z.string(),
+  dataBase64: z.string(),
+})
+export type ExportedFile = z.infer<typeof ExportedFile>
+
+/**
+ * Model export — serialize the scene (or selection) to a downloadable 3D file.
+ *
+ * `core.io.export.model` hands you the file bytes as base64 — no download
+ * dialog opens; the plugin decides what to do with the result (save it, POST
+ * it, diff it). For a different export intent, see `presentation.export`
+ * (Present-mode layout sheets to PDF/PNG/JPG) and `program.spreadsheet.export`
+ * (the area-program / takeoff workbook). Four formats:
+ *
+ * - `"glb"` — binary glTF (`model/gltf-binary`); geometry + materials,
+ *   serialized in the browser (nothing is uploaded).
+ * - `"obj"` — Wavefront OBJ text (`text/plain`); geometry only, serialized in
+ *   the browser.
+ * - `"fbx"` / `"3ds"` — Autodesk FBX / 3D Studio; the scene is uploaded to the
+ *   same `/exportmodel/` conversion service the app's Export dialog uses, and
+ *   the call resolves once the converted artifact is fetched back — a **zip**
+ *   (`application/zip`) containing the `.fbx`/`.3ds` file. Whole-scene only
+ *   (`scope: "selection"` is rejected). Conversion runs on the server and is
+ *   bounded by the per-call plugin timeout (60 s) — very large models may
+ *   exceed it and reject with `TIMEOUT`.
+ *
+ * For the browser formats, only real model geometry is exported (walls, slabs,
+ * roofs, floors, doors, windows, furniture, staircases, masses, ceilings,
+ * mullions, beams, columns, terrain); UI helpers, hidden objects, and
+ * hidden-bucket objects are excluded — matching the app's GLB export. The
+ * server formats convert the full serialized scene (hidden-bucket objects
+ * excluded), exactly like the Export dialog. This is a **read**: it never
+ * mutates the model.
+ *
+ * > Server-backed BIM exports (RVT / IFC / DWG) are **not** exposed here — those
+ * > run as fire-and-forget Forge jobs that stream a browser download and return
+ * > no retrievable bytes. Use the app's Export menu for those.
+ *
+ * Accessed via `snaptrude.core.io.export`.
+ */
+export abstract class PluginCoreIoExportApi {
+  constructor() {}
+
+  /**
+   * Export the model to a 3D file and return its bytes as base64.
+   *
+   * @param format - `"glb"` (binary glTF, geometry + materials), `"obj"`
+   *   (Wavefront OBJ text, geometry only) — both serialized in the browser —
+   *   or `"fbx"` / `"3ds"`, converted by the app's export service and returned
+   *   as a zip containing the converted file.
+   * @param scope - `"scene"` (default) for the whole model, or `"selection"` for
+   *   only the currently selected objects (browser formats only — `"fbx"`/`"3ds"`
+   *   reject it). An empty selection yields an empty file.
+   * @returns an {@linkcode ExportedFile} — `{ fileName, mimeType, dataBase64 }`.
+   * @throws if the format is unsupported, `scope: "selection"` is combined with a
+   *   server format, or the serialization/conversion fails.
+   *
+   * @examplePrompt Export the model as a GLB
+   * @examplePrompt Give me the whole scene as an OBJ file
+   * @examplePrompt Export just my selection to GLB
+   * @examplePrompt Download the model as an FBX file
+   * @examplePrompt Export the scene to 3DS for 3ds Max
+   *
+   * # Example
+   * ```ts
+   * const file = await snaptrude.core.io.export.model("glb")
+   * // decode base64 → bytes and save/download in the plugin UI
+   * const bytes = Uint8Array.from(atob(file.dataBase64), (c) => c.charCodeAt(0))
+   * const blob = new Blob([bytes], { type: file.mimeType })
+   * // ...offer blob for download as file.fileName
+   *
+   * // Only the current selection, as OBJ text:
+   * const obj = await snaptrude.core.io.export.model("obj", "selection")
+   * const text = atob(obj.dataBase64)
+   * ```
+   */
+  public abstract model(
+    format: ExportModelFormat,
+    scope?: ExportScope,
+  ): PluginApiReturn<ExportedFile>
+}
+
+/**
+ * Arguments for {@link PluginCoreIoExportApi.model}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `format` | {@link ExportModelFormat} | `"glb"`, `"obj"`, `"fbx"`, or `"3ds"` |
+ * | `scope` | {@link ExportScope} | `"scene"` (default) or `"selection"` (browser formats only) |
+ */
+export const PluginExportModelArgs = z.object({
+  format: ExportModelFormat,
+  scope: ExportScope.optional(),
+})
+export type PluginExportModelArgs = z.infer<typeof PluginExportModelArgs>