@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

package/dist/api/core/buildings.d.ts

@@ -0,0 +1,427 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Buildings — read and edit the buildings of the active project.
+ *
+ * A **building** is the top of the project's spatial hierarchy: a named container
+ * of storeys, positioned by its base elevation. This namespace reads a building's
+ * identity and base elevation and lists the storeys it holds; storey detail is
+ * read through the entity story surface (`snaptrude.entity.story`).
+ *
+ * Reads return plain records and never throw for a missing building (`get` and
+ * `getActive` return `null`, `list` returns `[]`). Ids are stable public strings.
+ *
+ * Sub-namespace members typed as optional (`?`) are **authored ahead of the
+ * host** — declared so plugins and codegen can see the shape, but kept out of the
+ * discovery manifest until the host lands them (at which point they are promoted
+ * to required `abstract` members).
+ *
+ * Accessed via `snaptrude.core.buildings`.
+ */
+export declare abstract class PluginCoreBuildingsApi {
+    constructor();
+    /**
+     * List the buildings in the active project.
+     *
+     * @returns A {@linkcode PluginCoreBuildingsListResult} with a `buildings` array
+     *   (empty when the project has none).
+     *
+     * @examplePrompt List all the buildings in my project
+     * @examplePrompt How many buildings are in this model?
+     * @examplePrompt Show every building with its base elevation
+     *
+     * # Example
+     * ```ts
+     * const { buildings } = await snaptrude.core.buildings.list()
+     * for (const b of buildings) console.log(b.name, b.baseElevation)
+     * ```
+     */
+    abstract list(): PluginApiReturn<PluginCoreBuildingsListResult>;
+    /**
+     * Get a single building by id.
+     *
+     * @param buildingId - The id of the building to read.
+     * @returns The matching {@linkcode PluginCoreBuildingRef}, or `null` if no
+     *   building has that id.
+     *
+     * @examplePrompt Get the building with id blg_1
+     * @examplePrompt Look up a single building by its id
+     * @examplePrompt What is the base elevation of building blg_2?
+     *
+     * # Example
+     * ```ts
+     * const building = await snaptrude.core.buildings.get("blg_1")
+     * if (building) console.log(building.name, building.baseElevation)
+     * ```
+     */
+    abstract get(buildingId: string): PluginApiReturn<PluginCoreBuildingsGetResult>;
+    /**
+     * List the storeys of a building.
+     *
+     * Returns the building's storeys as stable storey ids, in the project's storey
+     * order. Read each storey's detail through `snaptrude.entity.story`.
+     *
+     * @param buildingId - The id of the building whose storeys to list.
+     * @returns A {@linkcode PluginCoreBuildingsListStoreysResult} with a `storeyIds`
+     *   array (empty when the building is missing or has no storeys).
+     *
+     * @examplePrompt List the storeys in building blg_1
+     * @examplePrompt How many floors does this building have?
+     * @examplePrompt Get the storey ids of the active building
+     *
+     * # Example
+     * ```ts
+     * const { storeyIds } = await snaptrude.core.buildings.listStoreys("blg_1")
+     * console.log(`${storeyIds.length} storeys`)
+     * ```
+     */
+    abstract listStoreys(buildingId: string): PluginApiReturn<PluginCoreBuildingsListStoreysResult>;
+    /**
+     * Get the active building.
+     *
+     * The active building is the one new storeys and edits target. Paired with
+     * {@linkcode PluginCoreBuildingsApi.setActive}.
+     *
+     * @returns A {@linkcode PluginCoreBuildingsGetActiveResult} with the active
+     *   `buildingId`, or `null` if there is no active building.
+     *
+     * @examplePrompt Which building is active?
+     * @examplePrompt Get the current building
+     * @examplePrompt What building am I working in?
+     *
+     * # Example
+     * ```ts
+     * const active = await snaptrude.core.buildings.getActive()
+     * if (active) console.log(active.buildingId)
+     * ```
+     */
+    abstract getActive(): PluginApiReturn<PluginCoreBuildingsGetActiveResult>;
+    /**
+     * Make a building the active building.
+     *
+     * Paired with {@linkcode PluginCoreBuildingsApi.getActive}.
+     *
+     * @param buildingId - The id of the building to activate.
+     * @returns The id of the now-active building.
+     * @throws If no building has the given id.
+     *
+     * @examplePrompt Switch to building blg_2
+     * @examplePrompt Make this building the active one
+     * @examplePrompt Set the active building to blg_1
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.buildings.setActive("blg_2")
+     * ```
+     */
+    abstract setActive(buildingId: string): PluginApiReturn<PluginCoreBuildingsSetActiveResult>;
+    /**
+     * Create a new building.
+     *
+     * Adds a named building at the given base elevation (defaults to `0`). The new
+     * building starts empty — add storeys through the storeys namespace.
+     *
+     * @param name - Display name of the new building.
+     * @param baseElevation - Base elevation in meters (defaults to `0`).
+     * @returns The new building's id (read the full record back with
+     *   {@linkcode PluginCoreBuildingsApi.get}).
+     * @throws If the building could not be created.
+     *
+     * @examplePrompt Create a building called Tower B
+     * @examplePrompt Add a new building at elevation 12 meters
+     * @examplePrompt Make a second building named Annex
+     *
+     * # Example
+     * ```ts
+     * const { buildingId } = await snaptrude.core.buildings.create("Tower B", 0)
+     * ```
+     */
+    abstract create(name: string, baseElevation?: number): PluginApiReturn<PluginCoreBuildingsCreateResult>;
+    /**
+     * Update a building's name and/or base elevation.
+     *
+     * A **sparse** update: omitted fields are left unchanged.
+     *
+     * @param buildingId - The id of the building to update.
+     * @param options - Any of `name`, `baseElevation`; omitted fields are left
+     *   unchanged.
+     * @returns The updated {@linkcode PluginCoreBuildingRef}.
+     * @throws If no building has the given id.
+     *
+     * @examplePrompt Rename building blg_1 to Tower A
+     * @examplePrompt Move the building up to elevation 6 meters
+     * @examplePrompt Change the base elevation of blg_2
+     *
+     * # Example
+     * ```ts
+     * const building = await snaptrude.core.buildings.update("blg_1", { name: "Tower A" })
+     * ```
+     */
+    abstract update(buildingId: string, options?: {
+        name?: string;
+        baseElevation?: number;
+    }): PluginApiReturn<PluginCoreBuildingsUpdateResult>;
+    /**
+     * Copy a building.
+     *
+     * Copies the building — its storeys, components, and drawing layers — into a new
+     * building. `asInstances` controls the copy's geometry: `true` shares the source
+     * geometry as instances (low memory), `false` makes independent editable copies
+     * (the host defaults to `true`). Optionally override the copy's `name` and
+     * `baseElevation`.
+     *
+     * @param buildingId - The id of the building to copy.
+     * @param options - Optional `name`, `baseElevation`, `asInstances` overrides
+     *   for the copy.
+     * @returns The new building's id.
+     * @throws If no building has the given id.
+     *
+     * @examplePrompt Copy building blg_1
+     * @examplePrompt Make an independent editable copy of this building
+     * @examplePrompt Copy Tower A as instances to save memory
+     *
+     * # Example
+     * ```ts
+     * const { buildingId } = await snaptrude.core.buildings.copy("blg_1", {
+     *   name: "Tower A Copy",
+     *   asInstances: false,
+     * })
+     * ```
+     */
+    abstract copy(buildingId: string, options?: {
+        name?: string;
+        baseElevation?: number;
+        asInstances?: boolean;
+    }): PluginApiReturn<PluginCoreBuildingsCopyResult>;
+    /**
+     * Delete a building.
+     *
+     * **Gated and destructive.** Deleting a building cascades through its meshes,
+     * storeys, and the building itself, and removes its saved views — **saved views
+     * are not restored on undo.** The project's only remaining building cannot be
+     * deleted.
+     *
+     * @param buildingId - The id of the building to delete.
+     * @returns Confirmation that the building was deleted.
+     * @throws If no building has the given id, or it is the only building.
+     *
+     * @examplePrompt Delete building blg_2
+     * @examplePrompt Remove the Annex building and everything in it
+     * @examplePrompt Delete this building
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.buildings.delete("blg_2")
+     * ```
+     */
+    abstract delete(buildingId: string): PluginApiReturn<PluginCoreBuildingsDeleteResult>;
+}
+/**
+ * A building in the active project.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Stable public building id (e.g. `"blg_1"`) |
+ * | `name` | `string` | Display name |
+ * | `baseElevation` | `number` | Base elevation in meters, positive up (default `0`) |
+ */
+export declare const PluginCoreBuildingRef: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    baseElevation: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginCoreBuildingRef = z.infer<typeof PluginCoreBuildingRef>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildings` | {@linkcode PluginCoreBuildingRef}`[]` | Every building in the active project |
+ */
+export declare const PluginCoreBuildingsListResult: z.ZodObject<{
+    buildings: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        baseElevation: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsListResult = z.infer<typeof PluginCoreBuildingsListResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building to read |
+ */
+export declare const PluginCoreBuildingsGetArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsGetArgs = z.infer<typeof PluginCoreBuildingsGetArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.get} — the building, or `null` when
+ * no building has the given id.
+ */
+export declare const PluginCoreBuildingsGetResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    baseElevation: z.ZodNumber;
+}, z.core.$strip>>;
+export type PluginCoreBuildingsGetResult = z.infer<typeof PluginCoreBuildingsGetResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.listStoreys}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building whose storeys to list |
+ */
+export declare const PluginCoreBuildingsListStoreysArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsListStoreysArgs = z.infer<typeof PluginCoreBuildingsListStoreysArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.listStoreys}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeyIds` | `string[]` | The building's storey ids in storey order (empty when missing or none) |
+ */
+export declare const PluginCoreBuildingsListStoreysResult: z.ZodObject<{
+    storeyIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsListStoreysResult = z.infer<typeof PluginCoreBuildingsListStoreysResult>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.getActive} — the active building's
+ * id, or `null` when there is no active building.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the active building |
+ */
+export declare const PluginCoreBuildingsGetActiveResult: z.ZodNullable<z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>>;
+export type PluginCoreBuildingsGetActiveResult = z.infer<typeof PluginCoreBuildingsGetActiveResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building to activate |
+ */
+export declare const PluginCoreBuildingsSetActiveArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsSetActiveArgs = z.infer<typeof PluginCoreBuildingsSetActiveArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.setActive} — the now-active
+ * building's id.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the now-active building |
+ */
+export declare const PluginCoreBuildingsSetActiveResult: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsSetActiveResult = z.infer<typeof PluginCoreBuildingsSetActiveResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.create}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `name` | `string` | Display name of the new building |
+ * | `baseElevation` | `number \| undefined` | Base elevation in meters (defaults to `0`) |
+ */
+export declare const PluginCoreBuildingsCreateArgs: z.ZodObject<{
+    name: z.ZodString;
+    baseElevation: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsCreateArgs = z.infer<typeof PluginCoreBuildingsCreateArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.create} — the id of the new
+ * building.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the newly created building |
+ */
+export declare const PluginCoreBuildingsCreateResult: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsCreateResult = z.infer<typeof PluginCoreBuildingsCreateResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.update}. Sparse — only the
+ * provided fields are changed.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building to update |
+ * | `name` | `string \| undefined` | New display name (unchanged if omitted) |
+ * | `baseElevation` | `number \| undefined` | New base elevation in meters (unchanged if omitted) |
+ */
+export declare const PluginCoreBuildingsUpdateArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    baseElevation: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsUpdateArgs = z.infer<typeof PluginCoreBuildingsUpdateArgs>;
+/** Result of {@linkcode PluginCoreBuildingsApi.update} — the updated record. */
+export declare const PluginCoreBuildingsUpdateResult: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    baseElevation: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginCoreBuildingsUpdateResult = z.infer<typeof PluginCoreBuildingsUpdateResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.copy}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building to copy |
+ * | `name` | `string \| undefined` | Name for the copy (auto-generated if omitted) |
+ * | `baseElevation` | `number \| undefined` | Base elevation for the copy in meters (source's if omitted) |
+ * | `asInstances` | `boolean \| undefined` | `true` shares source geometry as instances; `false` makes independent copies (host default `true`) |
+ */
+export declare const PluginCoreBuildingsCopyArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    baseElevation: z.ZodOptional<z.ZodNumber>;
+    asInstances: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsCopyArgs = z.infer<typeof PluginCoreBuildingsCopyArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.copy} — the id of the new
+ * building.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the copied building |
+ */
+export declare const PluginCoreBuildingsCopyResult: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsCopyResult = z.infer<typeof PluginCoreBuildingsCopyResult>;
+/**
+ * Arguments for {@linkcode PluginCoreBuildingsApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `buildingId` | `string` | The id of the building to delete |
+ */
+export declare const PluginCoreBuildingsDeleteArgs: z.ZodObject<{
+    buildingId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreBuildingsDeleteArgs = z.infer<typeof PluginCoreBuildingsDeleteArgs>;
+/**
+ * Result of {@linkcode PluginCoreBuildingsApi.delete} — confirmation that the
+ * building was deleted.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `deleted` | `true` | Always `true` on success |
+ */
+export declare const PluginCoreBuildingsDeleteResult: z.ZodObject<{
+    deleted: z.ZodLiteral<true>;
+}, z.core.$strip>;
+export type PluginCoreBuildingsDeleteResult = z.infer<typeof PluginCoreBuildingsDeleteResult>;
+//# sourceMappingURL=buildings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"buildings.d.ts","sourceRoot":"","sources":["../../../src/api/core/buildings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,6BAA6B,CAAC;IAEtE;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAEhF;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,GACrB,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,IAAI,CAClB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GACzE,eAAe,CAAC,6BAA6B,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,CAAC;CACpD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;kBAAmC,CAAA;AAC5E,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;kBAIlC,CAAA;AACb,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,6BAA6B;;;;iBAIxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,+BAA+B;;;;iBAAwB,CAAA;AACpE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B;;;;;iBAKtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA"}

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

@@ -0,0 +1,261 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+import { Vec3Handle } from "../../../handles";
+/**
+ * Camera controls.
+ *
+ * Position the viewport camera, snap it to a standard orthographic/isometric
+ * view, and toggle between the 2D (plan) and 3D modelling modes — mirrors the
+ * canvas view menu and the 2D/3D toggle. Like {@linkcode PluginZoomApi}, these
+ * are transient VIEW-STATE changes: they are not model edits, so they are not
+ * write-gated and are not undoable. Accessed via `snaptrude.core.camera`.
+ */
+export declare abstract class PluginCameraApi {
+    constructor();
+    /**
+     * Point the camera: place its eye at `eye` looking toward `target` (world
+     * coordinates, internal `babylon` units). View-state only — not undoable.
+     *
+     * @param eye - Camera position as a {@linkcode Vec3Handle}
+     * @param target - Point the camera looks at as a {@linkcode Vec3Handle}
+     * @returns `true` once the camera has been positioned.
+     *
+     * @examplePrompt Look at the model from above the north-east corner
+     * @examplePrompt Position the camera at (50, 30, 50) looking at the origin
+     * @examplePrompt Point the camera at the centre of the building from the side
+     * @examplePrompt Set the eye to this point and aim it at that point
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     * await snaptrude.core.camera.lookFrom(vec3.new(50, 30, 50), vec3.new(0, 0, 0))
+     * ```
+     */
+    abstract lookFrom(eye: Vec3Handle, target: Vec3Handle): PluginApiReturn<boolean>;
+    /**
+     * Snap the camera to a standard view — the five orthographic elevations
+     * (`top` / `front` / `back` / `left` / `right`) or the 3D `iso` (isometric
+     * perspective) view. Mirrors the canvas view menu. View-state only — not
+     * undoable. The orthographic presets exit 2D mode first if needed.
+     *
+     * @param view - The standard view to snap to ({@linkcode PluginStandardView})
+     * @returns `true` once the view has been applied.
+     *
+     * @examplePrompt Switch to the top view
+     * @examplePrompt Show me the front elevation
+     * @examplePrompt Go to the isometric view
+     * @examplePrompt Look at the model from the left
+     * @examplePrompt Give me a plan view from the top
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.setStandardView("top")
+     * ```
+     */
+    abstract setStandardView(view: PluginStandardView): PluginApiReturn<boolean>;
+    /**
+     * Get the current camera mode. Paired with {@linkcode PluginCameraApi.setMode}.
+     *
+     * @returns `"2d"` when the editor is in plan view, `"3d"` otherwise.
+     *
+     * @examplePrompt Am I in 2D or 3D?
+     * @examplePrompt What view mode is the editor in?
+     *
+     * # Example
+     * ```ts
+     * if ((await snaptrude.core.camera.getMode()) === "2d") {
+     *   await snaptrude.core.camera.setMode("3d")
+     * }
+     * ```
+     */
+    abstract getMode(): PluginApiReturn<PluginCameraMode>;
+    /**
+     * Toggle the modelling mode between `2d` (plan) and `3d`. Mirrors the canvas
+     * 2D/3D toggle: `3d` enters the isometric perspective view, `2d` drops to the
+     * orthographic plan of the active storey. View-state only — not undoable.
+     *
+     * @param mode - `"2d"` or `"3d"` ({@linkcode PluginCameraMode})
+     * @returns `true` once the mode switch has been requested.
+     *
+     * @examplePrompt Switch to 3D view
+     * @examplePrompt Drop into 2D plan mode
+     * @examplePrompt Go back to 3D
+     * @examplePrompt Show the floor plan in 2D
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.setMode("3d")
+     * ```
+     */
+    abstract setMode(mode: PluginCameraMode): PluginApiReturn<boolean>;
+    /**
+     * Read the camera's current projection: `"perspective"` (the default 3D
+     * view) or `"orthographic"`. In 2D (plan) mode this always reports
+     * `"orthographic"` — a plan is an orthographic projection.
+     *
+     * @returns The current {@linkcode PluginCameraProjection}.
+     *
+     * @examplePrompt Is the camera in perspective or orthographic?
+     * @examplePrompt What projection is the 3D view using?
+     * @examplePrompt Check whether perspective is on
+     *
+     * # Example
+     * ```ts
+     * const projection = await snaptrude.core.camera.getProjection()
+     * console.log(projection) // "perspective" | "orthographic"
+     * ```
+     */
+    abstract getProjection(): PluginApiReturn<PluginCameraProjection>;
+    /**
+     * Switch the 3D camera between `"perspective"` and `"orthographic"`
+     * projection — the Perspective/Orthographic control in the Design tab's
+     * View Settings panel. Like {@linkcode PluginCameraApi.setMode}, this is a
+     * transient view-state change: not write-gated, not undoable.
+     *
+     * In 2D (plan) mode the canvas is always an orthographic plan:
+     * `"orthographic"` is accepted as a no-op, while `"perspective"` is
+     * rejected — switch to 3D first via `setMode("3d")`.
+     *
+     * @param projection - `"perspective"` or `"orthographic"` ({@linkcode PluginCameraProjection})
+     * @returns `true` once the projection has been applied.
+     *
+     * @examplePrompt Switch the camera to orthographic
+     * @examplePrompt Turn perspective off
+     * @examplePrompt Give me a perspective view of the model
+     * @examplePrompt Make the 3D view orthographic like an axonometric drawing
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.setProjection("orthographic")
+     * const projection = await snaptrude.core.camera.getProjection() // "orthographic"
+     * ```
+     */
+    abstract setProjection(projection: PluginCameraProjection): PluginApiReturn<boolean>;
+    /**
+     * Zoom (fit) the camera to all geometry in the scene — the "zoom extents"
+     * action. View-state only — not undoable. Canonical home of the zoom-extents
+     * read (the deprecated `core.zoom.extents`).
+     *
+     * @returns `true` once the camera has been framed to the scene.
+     *
+     * @examplePrompt Zoom out so I can see the whole model
+     * @examplePrompt Fit everything in the view
+     * @examplePrompt Frame the entire building in the viewport
+     * @examplePrompt Do a zoom extents on the canvas
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.zoomExtents()
+     * ```
+     */
+    abstract zoomExtents(): PluginApiReturn<boolean>;
+    /**
+     * Zoom (fit) the camera to the current selection. View-state only — not
+     * undoable. Canonical home of the zoom-to-selection read (the deprecated
+     * `core.zoom.selection`).
+     *
+     * @returns `true` if there was a selection to frame; `false` if nothing is
+     *   selected (no-op).
+     *
+     * @examplePrompt Zoom in on what I have selected
+     * @examplePrompt Frame the selected walls in the view
+     * @examplePrompt Focus the camera on my current selection
+     * @examplePrompt Fit the view to the selected room
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.zoomSelection()
+     * ```
+     */
+    abstract zoomSelection(): PluginApiReturn<boolean>;
+}
+/**
+ * A standard camera view: the five orthographic elevations (`top`/`front`/
+ * `back`/`left`/`right`) or the 3D isometric perspective (`iso`).
+ */
+export declare const PluginStandardView: z.ZodEnum<{
+    top: "top";
+    front: "front";
+    back: "back";
+    left: "left";
+    right: "right";
+    iso: "iso";
+}>;
+export type PluginStandardView = z.infer<typeof PluginStandardView>;
+/**
+ * The modelling mode: `2d` (orthographic plan) or `3d` (isometric perspective).
+ */
+export declare const PluginCameraMode: z.ZodEnum<{
+    "2d": "2d";
+    "3d": "3d";
+}>;
+export type PluginCameraMode = z.infer<typeof PluginCameraMode>;
+/**
+ * The 3D camera projection: `perspective` (the default) or `orthographic` —
+ * the Perspective/Orthographic control in the Design tab's View Settings panel.
+ */
+export declare const PluginCameraProjection: z.ZodEnum<{
+    perspective: "perspective";
+    orthographic: "orthographic";
+}>;
+export type PluginCameraProjection = z.infer<typeof PluginCameraProjection>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.lookFrom}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `eye` | {@linkcode Vec3Handle} | Camera position (world, `babylon` units) |
+ * | `target` | {@linkcode Vec3Handle} | Point the camera looks at |
+ */
+export declare const PluginCameraLookFromArgs: z.ZodObject<{
+    eye: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    target: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+}, z.core.$strip>;
+export type PluginCameraLookFromArgs = z.infer<typeof PluginCameraLookFromArgs>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.setStandardView}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `view` | {@linkcode PluginStandardView} | The standard view to snap to |
+ */
+export declare const PluginCameraSetStandardViewArgs: z.ZodObject<{
+    view: z.ZodEnum<{
+        top: "top";
+        front: "front";
+        back: "back";
+        left: "left";
+        right: "right";
+        iso: "iso";
+    }>;
+}, z.core.$strip>;
+export type PluginCameraSetStandardViewArgs = z.infer<typeof PluginCameraSetStandardViewArgs>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.setMode}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `mode` | {@linkcode PluginCameraMode} | `"2d"` or `"3d"` |
+ */
+export declare const PluginCameraSetModeArgs: z.ZodObject<{
+    mode: z.ZodEnum<{
+        "2d": "2d";
+        "3d": "3d";
+    }>;
+}, z.core.$strip>;
+export type PluginCameraSetModeArgs = z.infer<typeof PluginCameraSetModeArgs>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.setProjection}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `projection` | {@linkcode PluginCameraProjection} | `"perspective"` or `"orthographic"` |
+ */
+export declare const PluginCameraSetProjectionArgs: z.ZodObject<{
+    projection: z.ZodEnum<{
+        perspective: "perspective";
+        orthographic: "orthographic";
+    }>;
+}, z.core.$strip>;
+export type PluginCameraSetProjectionArgs = z.infer<typeof PluginCameraSetProjectionArgs>;
+//# sourceMappingURL=index.d.ts.map