@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

package/dist/api/presentation/sheets.d.ts

@@ -0,0 +1,643 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation sheets — the layout sheets a presentation is assembled on.
+ *
+ * A **sheet** is a page in Present mode that views and diagrams are placed onto.
+ * These methods require **Present mode to be open** (the documentation editor) —
+ * reads return `[]`/`null` and writes throw when it is not.
+ *
+ * `list`/`get` are reads; the rest mutate and require Present mode to be open:
+ * `create` adds a sheet, `place` drops a saved view onto a sheet as a live
+ * linked view shape, `rename` relabels a sheet, `delete` removes one, `reorder`
+ * moves one in the sheet order, `setActive` navigates to one, and
+ * `updatePlacedView` re-renders placed views to the current model.
+ *
+ * Accessed via `snaptrude.presentation.sheets`.
+ */
+export declare abstract class PluginPresentationSheetsApi {
+    constructor();
+    /**
+     * List the layout sheets in the presentation.
+     *
+     * @returns A {@linkcode PluginPresentationSheetsListResult} with a `sheets`
+     *   array (empty when Present mode is closed or there are no sheets).
+     *
+     * @examplePrompt List all the sheets
+     * @examplePrompt How many layout sheets are there?
+     * @examplePrompt Show me the presentation sheets
+     * @examplePrompt What sheets can I place views on?
+     *
+     * # Example
+     * ```ts
+     * const { sheets } = await snaptrude.presentation.sheets.list()
+     * ```
+     */
+    abstract list(): PluginApiReturn<PluginPresentationSheetsListResult>;
+    /**
+     * Get a single sheet by id.
+     *
+     * @param sheetId - The id of the sheet to read.
+     * @returns The matching {@linkcode PluginPresentationSheet}, or `null`.
+     *
+     * @examplePrompt Get the sheet with id sheet_1
+     * @examplePrompt Find the sheet called Cover
+     * @examplePrompt Look up a layout sheet by id
+     *
+     * # Example
+     * ```ts
+     * const sheet = await snaptrude.presentation.sheets.get("sheet_1")
+     * ```
+     */
+    abstract get(sheetId: string): PluginApiReturn<PluginPresentationSheetsGetResult>;
+    /**
+     * Create a new layout sheet.
+     *
+     * Optionally sets the paper size and orientation — the same presets as the
+     * sheet header's size dropdown (ANSI A–E, Arch A–E1, ISO A4–A0). When `size`
+     * is omitted the sheet inherits the editor session's last-used size
+     * (initially ANSI B) in landscape, so pass `size` explicitly whenever the
+     * output format matters.
+     *
+     * Requires Present mode to be open.
+     *
+     * @param name - Display name for the new sheet (optional).
+     * @param options - Optional `size` ({@linkcode PluginSheetSize} paper preset)
+     *   and `orientation` ({@linkcode PluginSheetOrientation}; `"landscape"` when
+     *   omitted).
+     * @returns The newly created {@linkcode PluginPresentationSheet}.
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Create a new sheet called Cover
+     * @examplePrompt Add an A3 landscape layout sheet
+     * @examplePrompt Make a new ANSI D presentation sheet named Floor Plans
+     * @examplePrompt Create a portrait A4 sheet
+     *
+     * # Example
+     * ```ts
+     * const sheet = await snaptrude.presentation.sheets.create("Cover", {
+     *   size: "ISO_A3",
+     *   orientation: "landscape",
+     * })
+     * ```
+     */
+    abstract create(name?: string, options?: {
+        size?: PluginSheetSize;
+        orientation?: PluginSheetOrientation;
+    }): PluginApiReturn<PluginPresentationSheet>;
+    /**
+     * Set a sheet's paper size and/or orientation.
+     *
+     * Applies one of the standard paper presets — exactly what the sheet header's
+     * size dropdown and orientation toggle do. Content that no longer fits inside
+     * the resized sheet is moved out onto the canvas (matching the native
+     * behavior). Undoable. Does not change the user's remembered default size for
+     * new sheets.
+     *
+     * Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet to resize.
+     * @param size - The paper preset ({@linkcode PluginSheetSize}).
+     * @param orientation - Optional {@linkcode PluginSheetOrientation}; keeps the
+     *   sheet's current orientation when omitted.
+     * @returns The updated {@linkcode PluginPresentationSheet}.
+     * @throws If Present mode is not open, or the sheet id is invalid.
+     *
+     * @examplePrompt Resize sheet_1 to A1
+     * @examplePrompt Make the cover sheet ANSI B portrait
+     * @examplePrompt Change this sheet to Arch D landscape
+     * @examplePrompt Set the sheet size to A3
+     *
+     * # Example
+     * ```ts
+     * const sheet = await snaptrude.presentation.sheets.setSize("sheet_1", "ISO_A1", "portrait")
+     * ```
+     */
+    abstract setSize(sheetId: string, size: PluginSheetSize, orientation?: PluginSheetOrientation): PluginApiReturn<PluginPresentationSheet>;
+    /**
+     * Set a sheet's print margin.
+     *
+     * Applies one of the canonical margin presets — exactly what the sheet
+     * header's margin dropdown does. `margin` is unit-agnostic: `0 | 0.25 |
+     * 0.5 | 0.75 | 1`, displayed as None / 1/4″ / 1/2″ / 3/4″ / 1″ on imperial
+     * projects and None / 5mm / 10mm / 15mm / 20mm on metric ones. One undo
+     * step. Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet.
+     * @param margin - The margin preset ({@linkcode PluginSheetMargin}).
+     * @returns The updated {@linkcode PluginPresentationSheet}.
+     * @throws If Present mode is not open, or the sheet id is invalid.
+     *
+     * @examplePrompt Set the sheet margin to half an inch
+     * @examplePrompt Remove the margins on sheet_1
+     * @examplePrompt Give the cover sheet a 10mm margin
+     *
+     * # Example
+     * ```ts
+     * const sheet = await snaptrude.presentation.sheets.setMargin("sheet_1", 0.5)
+     * ```
+     */
+    abstract setMargin(sheetId: string, margin: PluginSheetMargin): PluginApiReturn<PluginPresentationSheet>;
+    /**
+     * Place a saved view onto a sheet.
+     *
+     * Drops the given view onto the sheet through the **native view drop** — the
+     * placed shape is a live linked view (the same shape the Present views panel's
+     * drag-drop creates), re-rendered from the current model, so
+     * {@linkcode PluginPresentationSheetsApi.updatePlacedView} refreshes it later.
+     * 2D and site-plan views are placed at an architectural scale: the closest
+     * standard scale by default (the native auto-fit), or the explicit `scale`
+     * when given — one of the standard values the placed view's Scale dropdown
+     * offers for the project's unit system (metric `10, 20, 50, 100, 150, 200,
+     * 250, 500, 1000`; imperial e.g. `48` for 1/4″ = 1′, `96` for 1/8″ = 1′,
+     * `120` for 1″ = 10′). 3D views have no scale — passing `scale` for one
+     * throws. Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet to place onto.
+     * @param viewId - The id of the saved view to place.
+     * @param options - Optional `position` ({@linkcode PluginSheetPosition}) —
+     *   where to place it (sheet centre when omitted) — and `scale` — a standard
+     *   scale value for the project's unit system (2D/site-plan views only;
+     *   auto-fit when omitted).
+     * @returns A {@linkcode PluginPresentationSheetsPlaceResult} with the created
+     *   `shapeId`.
+     * @throws If Present mode is not open, the sheet/view id is invalid, `scale`
+     *   is not a standard value for the project's unit system, or `scale` is
+     *   passed for a 3D view.
+     *
+     * @examplePrompt Place the floor plan on Sheet 1
+     * @examplePrompt Add this 3D view to the cover sheet
+     * @examplePrompt Drop the site plan onto the layout sheet at 100, 200
+     * @examplePrompt Put the Ground Floor view on sheet_1 at 1:100 scale
+     * @examplePrompt Place the plan on the cover sheet at quarter-inch scale
+     *
+     * # Example
+     * ```ts
+     * const { shapeId } = await snaptrude.presentation.sheets.place("sheet_1", "view_123", {
+     *   scale: 100, // 1:100 (metric project)
+     * })
+     * ```
+     */
+    abstract place(sheetId: string, viewId: string, options?: {
+        position?: PluginSheetPosition;
+        scale?: number;
+    }): PluginApiReturn<PluginPresentationSheetsPlaceResult>;
+    /**
+     * Move an existing drawing onto a sheet without copying or regenerating it.
+     *
+     * The position is sheet-local and defaults to the sheet centre. The drawing's
+     * stable id remains unchanged; `shapeId` therefore identifies the moved drawing.
+     *
+     * @param sheetId - The id of the destination sheet.
+     * @param drawingId - The id of an existing drawing deliverable.
+     * @param options - Optional sheet-local `position` (sheet centre when omitted).
+     * @returns A {@linkcode PluginPresentationSheetsPlaceResult} containing the drawing shape id.
+     * @throws If Present mode is closed, either id is invalid, or the shape is not a drawing.
+     *
+     * @examplePrompt Move this drawing onto the cover sheet
+     * @examplePrompt Place drawing_1 at the center of sheet_2
+     */
+    abstract placeDrawing(sheetId: string, drawingId: string, options?: {
+        position?: PluginSheetPosition;
+    }): PluginApiReturn<PluginPresentationSheetsPlaceResult>;
+    /**
+     * Rename a layout sheet.
+     *
+     * Sets the sheet's display name — the same label the sheets panel shows and
+     * that `list`/`get` read back. Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet to rename.
+     * @param name - The new display name (non-empty after trimming).
+     * @returns The updated {@linkcode PluginPresentationSheet}.
+     * @throws If Present mode is not open, or the sheet id is invalid.
+     *
+     * @examplePrompt Rename sheet_1 to Cover
+     * @examplePrompt Call the first sheet Ground Floor
+     * @examplePrompt Change this sheet's name to Site Plan
+     *
+     * # Example
+     * ```ts
+     * const sheet = await snaptrude.presentation.sheets.rename("sheet_1", "Cover")
+     * ```
+     */
+    abstract rename(sheetId: string, name: string): PluginApiReturn<PluginPresentationSheet>;
+    /**
+     * Delete a layout sheet.
+     *
+     * Removes the sheet (and its placed content) from the presentation and
+     * renumbers the remaining sheets. Requires Present mode to be open. Auto-diagram
+     * sheets cannot be deleted through the API — remove those from the Present UI.
+     *
+     * @param sheetId - The id of the sheet to delete.
+     * @returns The id of the deleted sheet
+     *   (a {@linkcode PluginPresentationSheetsDeleteResult}).
+     * @throws If Present mode is not open, the sheet id is invalid, or the sheet is
+     *   an auto-diagram sheet.
+     *
+     * @examplePrompt Delete sheet_2
+     * @examplePrompt Remove the Cover sheet
+     * @examplePrompt Get rid of the last layout sheet
+     *
+     * # Example
+     * ```ts
+     * const { id } = await snaptrude.presentation.sheets.delete("sheet_2")
+     * ```
+     */
+    abstract delete(sheetId: string): PluginApiReturn<PluginPresentationSheetsDeleteResult>;
+    /**
+     * Move a sheet to a new position in the sheet order.
+     *
+     * Reorders the sheet to the given zero-based `index` (as the sheets panel does
+     * when a sheet is dragged) and renumbers the rest. `index` is clamped to the
+     * valid range. Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet to move.
+     * @param index - Zero-based target position in the sheet order.
+     * @returns The sheets in their new order
+     *   (a {@linkcode PluginPresentationSheetsListResult}).
+     * @throws If Present mode is not open, or the sheet id is invalid.
+     *
+     * @examplePrompt Move sheet_3 to the front
+     * @examplePrompt Make the Cover sheet the first sheet
+     * @examplePrompt Reorder this sheet to position 2
+     *
+     * # Example
+     * ```ts
+     * const { sheets } = await snaptrude.presentation.sheets.reorder("sheet_3", 0)
+     * ```
+     */
+    abstract reorder(sheetId: string, index: number): PluginApiReturn<PluginPresentationSheetsListResult>;
+    /**
+     * Make a sheet the active sheet.
+     *
+     * Selects the sheet in the sheets panel and navigates the Present canvas to it
+     * (the same as clicking it in the panel). Requires Present mode to be open.
+     *
+     * @param sheetId - The id of the sheet to activate.
+     * @returns The now-active {@linkcode PluginPresentationSheet}.
+     * @throws If Present mode is not open, or the sheet id is invalid.
+     *
+     * @examplePrompt Go to sheet_1
+     * @examplePrompt Open the Cover sheet
+     * @examplePrompt Switch to the Site Plan sheet
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.presentation.sheets.setActive("sheet_1")
+     * ```
+     */
+    abstract setActive(sheetId: string): PluginApiReturn<PluginPresentationSheet>;
+    /**
+     * Refresh placed views to the current model state.
+     *
+     * Re-renders the presentation's placed **views** — the live linked view shapes —
+     * from the current model (the "Update views" action). Views placed with
+     * {@linkcode PluginPresentationSheetsApi.place} are live view shapes too, so
+     * they refresh along with panel-dropped ones. Pass `sheetId` to refresh only
+     * the views on that sheet, or omit it to refresh every placed view. Requires
+     * Present mode to be open.
+     *
+     * @param options - Optional `sheetId` — restrict the refresh to one sheet's
+     *   placed views (all placed views when omitted).
+     * @returns The ids of the placed view shapes submitted for refresh
+     *   (a {@linkcode PluginPresentationSheetsUpdatePlacedViewResult}).
+     * @throws If Present mode is not open, or `sheetId` is given but invalid.
+     *
+     * @examplePrompt Update all the placed views to the latest model
+     * @examplePrompt Refresh the views on sheet_1
+     * @examplePrompt Re-render the placed views after my edits
+     *
+     * # Example
+     * ```ts
+     * const { shapeIds } = await snaptrude.presentation.sheets.updatePlacedView()
+     * ```
+     */
+    abstract updatePlacedView(options?: {
+        sheetId?: string;
+    }): PluginApiReturn<PluginPresentationSheetsUpdatePlacedViewResult>;
+}
+/**
+ * Standard paper-size presets for layout sheets — identical to the sheet
+ * header's size dropdown in Present mode.
+ */
+export declare const PluginSheetSize: z.ZodEnum<{
+    ANSI_A: "ANSI_A";
+    ANSI_B: "ANSI_B";
+    ANSI_C: "ANSI_C";
+    ANSI_D: "ANSI_D";
+    ANSI_E: "ANSI_E";
+    ARCH_A: "ARCH_A";
+    ARCH_B: "ARCH_B";
+    ARCH_C: "ARCH_C";
+    ARCH_D: "ARCH_D";
+    ARCH_E: "ARCH_E";
+    ARCH_E1: "ARCH_E1";
+    ISO_A4: "ISO_A4";
+    ISO_A3: "ISO_A3";
+    ISO_A2: "ISO_A2";
+    ISO_A1: "ISO_A1";
+    ISO_A0: "ISO_A0";
+}>;
+export type PluginSheetSize = z.infer<typeof PluginSheetSize>;
+/** Sheet orientation. */
+export declare const PluginSheetOrientation: z.ZodEnum<{
+    landscape: "landscape";
+    portrait: "portrait";
+}>;
+export type PluginSheetOrientation = z.infer<typeof PluginSheetOrientation>;
+/**
+ * Canonical sheet margin presets — unit-agnostic values matching the sheet
+ * header's margin dropdown: `0` (None), `0.25`, `0.5`, `0.75`, `1`.
+ * Displayed as None / 1/4″ / 1/2″ / 3/4″ / 1″ on imperial projects and
+ * None / 5mm / 10mm / 15mm / 20mm on metric ones.
+ */
+export declare const PluginSheetMargin: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<0.25>, z.ZodLiteral<0.5>, z.ZodLiteral<0.75>, z.ZodLiteral<1>]>;
+export type PluginSheetMargin = z.infer<typeof PluginSheetMargin>;
+/**
+ * A layout sheet in the presentation.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Unique sheet id |
+ * | `name` | `string` | Display name |
+ * | `size` | {@linkcode PluginSheetSize}` \| null` | Paper preset (`null` for a legacy sheet without one) |
+ * | `orientation` | {@linkcode PluginSheetOrientation}` \| null` | Orientation (`null` for a legacy sheet) |
+ * | `margin` | {@linkcode PluginSheetMargin}` \| null` | Margin preset (`null` when absent/unrecognized) |
+ */
+export declare const PluginPresentationSheet: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    size: z.ZodNullable<z.ZodEnum<{
+        ANSI_A: "ANSI_A";
+        ANSI_B: "ANSI_B";
+        ANSI_C: "ANSI_C";
+        ANSI_D: "ANSI_D";
+        ANSI_E: "ANSI_E";
+        ARCH_A: "ARCH_A";
+        ARCH_B: "ARCH_B";
+        ARCH_C: "ARCH_C";
+        ARCH_D: "ARCH_D";
+        ARCH_E: "ARCH_E";
+        ARCH_E1: "ARCH_E1";
+        ISO_A4: "ISO_A4";
+        ISO_A3: "ISO_A3";
+        ISO_A2: "ISO_A2";
+        ISO_A1: "ISO_A1";
+        ISO_A0: "ISO_A0";
+    }>>;
+    orientation: z.ZodNullable<z.ZodEnum<{
+        landscape: "landscape";
+        portrait: "portrait";
+    }>>;
+    margin: z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<0.25>, z.ZodLiteral<0.5>, z.ZodLiteral<0.75>, z.ZodLiteral<1>]>>;
+}, z.core.$strip>;
+export type PluginPresentationSheet = z.infer<typeof PluginPresentationSheet>;
+/**
+ * A position on a sheet/canvas (sheet coordinates).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `x` | `number` | X coordinate |
+ * | `y` | `number` | Y coordinate |
+ */
+export declare const PluginSheetPosition: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginSheetPosition = z.infer<typeof PluginSheetPosition>;
+/** Result of {@linkcode PluginPresentationSheetsApi.list}. */
+export declare const PluginPresentationSheetsListResult: z.ZodObject<{
+    sheets: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        size: z.ZodNullable<z.ZodEnum<{
+            ANSI_A: "ANSI_A";
+            ANSI_B: "ANSI_B";
+            ANSI_C: "ANSI_C";
+            ANSI_D: "ANSI_D";
+            ANSI_E: "ANSI_E";
+            ARCH_A: "ARCH_A";
+            ARCH_B: "ARCH_B";
+            ARCH_C: "ARCH_C";
+            ARCH_D: "ARCH_D";
+            ARCH_E: "ARCH_E";
+            ARCH_E1: "ARCH_E1";
+            ISO_A4: "ISO_A4";
+            ISO_A3: "ISO_A3";
+            ISO_A2: "ISO_A2";
+            ISO_A1: "ISO_A1";
+            ISO_A0: "ISO_A0";
+        }>>;
+        orientation: z.ZodNullable<z.ZodEnum<{
+            landscape: "landscape";
+            portrait: "portrait";
+        }>>;
+        margin: z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<0.25>, z.ZodLiteral<0.5>, z.ZodLiteral<0.75>, z.ZodLiteral<1>]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsListResult = z.infer<typeof PluginPresentationSheetsListResult>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.get}. */
+export declare const PluginPresentationSheetsGetArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsGetArgs = z.infer<typeof PluginPresentationSheetsGetArgs>;
+/** Result of {@linkcode PluginPresentationSheetsApi.get} — the sheet, or `null`. */
+export declare const PluginPresentationSheetsGetResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    size: z.ZodNullable<z.ZodEnum<{
+        ANSI_A: "ANSI_A";
+        ANSI_B: "ANSI_B";
+        ANSI_C: "ANSI_C";
+        ANSI_D: "ANSI_D";
+        ANSI_E: "ANSI_E";
+        ARCH_A: "ARCH_A";
+        ARCH_B: "ARCH_B";
+        ARCH_C: "ARCH_C";
+        ARCH_D: "ARCH_D";
+        ARCH_E: "ARCH_E";
+        ARCH_E1: "ARCH_E1";
+        ISO_A4: "ISO_A4";
+        ISO_A3: "ISO_A3";
+        ISO_A2: "ISO_A2";
+        ISO_A1: "ISO_A1";
+        ISO_A0: "ISO_A0";
+    }>>;
+    orientation: z.ZodNullable<z.ZodEnum<{
+        landscape: "landscape";
+        portrait: "portrait";
+    }>>;
+    margin: z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<0.25>, z.ZodLiteral<0.5>, z.ZodLiteral<0.75>, z.ZodLiteral<1>]>>;
+}, z.core.$strip>>;
+export type PluginPresentationSheetsGetResult = z.infer<typeof PluginPresentationSheetsGetResult>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.create}. */
+export declare const PluginPresentationSheetsCreateArgs: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodEnum<{
+        ANSI_A: "ANSI_A";
+        ANSI_B: "ANSI_B";
+        ANSI_C: "ANSI_C";
+        ANSI_D: "ANSI_D";
+        ANSI_E: "ANSI_E";
+        ARCH_A: "ARCH_A";
+        ARCH_B: "ARCH_B";
+        ARCH_C: "ARCH_C";
+        ARCH_D: "ARCH_D";
+        ARCH_E: "ARCH_E";
+        ARCH_E1: "ARCH_E1";
+        ISO_A4: "ISO_A4";
+        ISO_A3: "ISO_A3";
+        ISO_A2: "ISO_A2";
+        ISO_A1: "ISO_A1";
+        ISO_A0: "ISO_A0";
+    }>>;
+    orientation: z.ZodOptional<z.ZodEnum<{
+        landscape: "landscape";
+        portrait: "portrait";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsCreateArgs = z.infer<typeof PluginPresentationSheetsCreateArgs>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.setSize}. */
+export declare const PluginPresentationSheetsSetSizeArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    size: z.ZodEnum<{
+        ANSI_A: "ANSI_A";
+        ANSI_B: "ANSI_B";
+        ANSI_C: "ANSI_C";
+        ANSI_D: "ANSI_D";
+        ANSI_E: "ANSI_E";
+        ARCH_A: "ARCH_A";
+        ARCH_B: "ARCH_B";
+        ARCH_C: "ARCH_C";
+        ARCH_D: "ARCH_D";
+        ARCH_E: "ARCH_E";
+        ARCH_E1: "ARCH_E1";
+        ISO_A4: "ISO_A4";
+        ISO_A3: "ISO_A3";
+        ISO_A2: "ISO_A2";
+        ISO_A1: "ISO_A1";
+        ISO_A0: "ISO_A0";
+    }>;
+    orientation: z.ZodOptional<z.ZodEnum<{
+        landscape: "landscape";
+        portrait: "portrait";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsSetSizeArgs = z.infer<typeof PluginPresentationSheetsSetSizeArgs>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.setMargin}. */
+export declare const PluginPresentationSheetsSetMarginArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    margin: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<0.25>, z.ZodLiteral<0.5>, z.ZodLiteral<0.75>, z.ZodLiteral<1>]>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsSetMarginArgs = z.infer<typeof PluginPresentationSheetsSetMarginArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationSheetsApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to place onto |
+ * | `viewId` | `string` | The saved view to place |
+ * | `position` | {@linkcode PluginSheetPosition}` \| undefined` | Where to place it (sheet centre when omitted) |
+ * | `scale` | `number \| undefined` | Standard scale value for the project's unit system (2D/site-plan views only; auto-fit to the closest standard scale when omitted) |
+ */
+export declare const PluginPresentationSheetsPlaceArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    viewId: z.ZodString;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+    scale: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsPlaceArgs = z.infer<typeof PluginPresentationSheetsPlaceArgs>;
+/** Arguments for moving an existing drawing onto a sheet. */
+export declare const PluginPresentationSheetsPlaceDrawingArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    drawingId: z.ZodString;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsPlaceDrawingArgs = z.infer<typeof PluginPresentationSheetsPlaceDrawingArgs>;
+/**
+ * Result of {@linkcode PluginPresentationSheetsApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeId` | `string` | Id of the created canvas shape |
+ */
+export declare const PluginPresentationSheetsPlaceResult: z.ZodObject<{
+    shapeId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsPlaceResult = z.infer<typeof PluginPresentationSheetsPlaceResult>;
+/**
+ * Arguments for {@linkcode PluginPresentationSheetsApi.rename}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to rename |
+ * | `name` | `string` | New display name (non-empty after trimming) |
+ */
+export declare const PluginPresentationSheetsRenameArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsRenameArgs = z.infer<typeof PluginPresentationSheetsRenameArgs>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.delete}. */
+export declare const PluginPresentationSheetsDeleteArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsDeleteArgs = z.infer<typeof PluginPresentationSheetsDeleteArgs>;
+/**
+ * Result of {@linkcode PluginPresentationSheetsApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Id of the deleted sheet |
+ */
+export declare const PluginPresentationSheetsDeleteResult: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsDeleteResult = z.infer<typeof PluginPresentationSheetsDeleteResult>;
+/**
+ * Arguments for {@linkcode PluginPresentationSheetsApi.reorder}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to move |
+ * | `index` | `number` | Zero-based target position (clamped to range) |
+ */
+export declare const PluginPresentationSheetsReorderArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    index: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginPresentationSheetsReorderArgs = z.infer<typeof PluginPresentationSheetsReorderArgs>;
+/** Arguments for {@linkcode PluginPresentationSheetsApi.setActive}. */
+export declare const PluginPresentationSheetsSetActiveArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationSheetsSetActiveArgs = z.infer<typeof PluginPresentationSheetsSetActiveArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationSheetsApi.updatePlacedView}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string`? | Restrict the refresh to one sheet's placed views |
+ */
+export declare const PluginPresentationSheetsUpdatePlacedViewArgs: z.ZodObject<{
+    sheetId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsUpdatePlacedViewArgs = z.infer<typeof PluginPresentationSheetsUpdatePlacedViewArgs>;
+/**
+ * Result of {@linkcode PluginPresentationSheetsApi.updatePlacedView}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeIds` | `string[]` | Ids of the placed view shapes submitted for refresh |
+ */
+export declare const PluginPresentationSheetsUpdatePlacedViewResult: z.ZodObject<{
+    shapeIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationSheetsUpdatePlacedViewResult = z.infer<typeof PluginPresentationSheetsUpdatePlacedViewResult>;
+//# sourceMappingURL=sheets.d.ts.map

package/dist/api/presentation/sheets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sheets.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/sheets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAE3E;;;;;;;;;;;;;;OAcG;aACa,GAAG,CACjB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,iCAAiC,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,eAAe,CAAC;QAAC,WAAW,CAAC,EAAE,sBAAsB,CAAA;KAAE,GACzE,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,OAAO,CACrB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,eAAe,EACrB,WAAW,CAAC,EAAE,sBAAsB,GACnC,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,GACxB,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,mBAAmB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3D,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;OAcG;aACa,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,mBAAmB,CAAA;KAAE,GAC3C,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,CACrB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,gBAAgB,CAAC,OAAO,CAAC,EAAE;QACzC,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,GAAG,eAAe,CAAC,8CAA8C,CAAC;CACpE;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;EAiB1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,yBAAyB;AACzB,eAAO,MAAM,sBAAsB;;;EAAoC,CAAA;AACvE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,oHAM5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;iBAG9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE,8DAA8D;AAC9D,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,iEAAiE;AACjE,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,oFAAoF;AACpF,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;kBACV,CAAA;AACpC,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,qEAAqE;AACrE,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;iBAI9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,qCAAqC;;;iBAGhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;iBAK5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,6DAA6D;AAC7D,eAAO,MAAM,wCAAwC;;;;;;;iBAInD,CAAA;AACF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,oEAAoE;AACpE,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,mCAAmC;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4CAA4C;;iBAEvD,CAAA;AACF,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,4CAA4C,CACpD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8CAA8C;;iBAEzD,CAAA;AACF,MAAM,MAAM,8CAA8C,GAAG,CAAC,CAAC,KAAK,CAClE,OAAO,8CAA8C,CACtD,CAAA"}