@snaptrude/plugin-core 0.6.0 → 0.7.0

package/src/api/design/windows/index.ts

@@ -2,14 +2,21 @@ import * as z from "zod"
 import { PluginApiReturn } from "../../../types"
 import { ComponentHandle } from "../../../handles"
 import { PluginDesignChangeResult } from "../lock"
+import { PluginObjectCatalogGroup, PluginObjectCatalogItem } from "../doors"
 
 /**
  * `snaptrude.design.windows` — window-specific reads. Creation lives at
  * `design.create.window`; generic reads (`listWindows`/`getHost`/`getProperties`) live
  * at `design.query.*`. Window targets are {@linkcode ComponentHandle}s.
  *
- * `listTypes` (UI-const catalog), `getSillHeight` (bounds-derived), and the
- * command-wired `mirror` land in a later pass.
+ * The **catalog** reads (`listCatalogGroups`/`listCatalog`/`getCatalogItem`/`exists`)
+ * browse the placeable window library — plain value records keyed by a library id
+ * (team `_id` or general `fullName`), NOT handles — and feed `design.create.window`.
+ * They are network-backed but carry no `Async` suffix (§6.6) and never throw
+ * (`[]`/`null`). The {@linkcode PluginObjectCatalogGroup} / {@linkcode PluginObjectCatalogItem}
+ * DTOs are shared with `design.doors` (defined there, re-exported here).
+ *
+ * `getSillHeight` (bounds-derived) and the command-wired `mirror` land in a later pass.
  */
 export abstract class PluginDesignWindowsApi {
   constructor() {}
@@ -148,6 +155,91 @@ export abstract class PluginDesignWindowsApi {
     window: ComponentHandle,
     height: number
   ): PluginApiReturn<PluginDesignChangeResult>
+
+  /**
+   * List the window catalog **groups** — the placement families (Fixed,
+   * Casement, Sliding, Folding, …), built-in groups merged with any
+   * team-custom types.
+   *
+   * @returns The groups as {@linkcode PluginObjectCatalogGroup}`[]` (`[]` when empty)
+   *
+   * @examplePrompt What kinds of windows can I place?
+   * @examplePrompt List the window groups in the catalog
+   * @examplePrompt Show me the window families available in this project
+   * @examplePrompt Which window types does this project support?
+   *
+   * # Example
+   * ```ts
+   * const groups = await snaptrude.design.windows.listCatalogGroups()
+   * for (const g of groups) console.log(g.dbType, g.label, g.source)
+   * ```
+   */
+  public abstract listCatalogGroups(): PluginApiReturn<PluginObjectCatalogGroup[]>
+
+  /**
+   * List the placeable window catalog (team + general libraries), optionally
+   * restricted to one group by its `dbType` token.
+   *
+   * @param group Restrict to one group's `dbType` (optional; e.g. `"casementDouble"`)
+   * @returns The catalog as {@linkcode PluginObjectCatalogItem}`[]` (`[]` when empty)
+   *
+   * @examplePrompt What windows can I place in this project?
+   * @examplePrompt List every window in the library
+   * @examplePrompt Show me the casement windows I can add
+   * @examplePrompt Browse the window catalog
+   *
+   * # Example
+   * ```ts
+   * const [group] = await snaptrude.design.windows.listCatalogGroups()
+   * const items = await snaptrude.design.windows.listCatalog(group?.dbType)
+   * for (const item of items) console.log(item.id, item.name, item.thumbnailUrl)
+   * ```
+   */
+  public abstract listCatalog(
+    group?: string
+  ): PluginApiReturn<PluginObjectCatalogItem[]>
+
+  /**
+   * Get a single window catalog item by its library id.
+   *
+   * @param id The catalog library id
+   * @returns The item, or `null` if no catalog item matches
+   *
+   * @examplePrompt Get the details of this window from the library
+   * @examplePrompt Look up the catalog entry for this window id
+   * @examplePrompt What is the cost of this window item?
+   * @examplePrompt Show me the family name of this window in the catalog
+   *
+   * # Example
+   * ```ts
+   * const [entry] = await snaptrude.design.windows.listCatalog()
+   * const item = await snaptrude.design.windows.getCatalogItem(entry.id)
+   * if (item) console.log(item.name, item.source, item.dbType)
+   * ```
+   */
+  public abstract getCatalogItem(
+    id: string
+  ): PluginApiReturn<PluginObjectCatalogItem | null>
+
+  /**
+   * Test whether a window catalog item exists for the given library id.
+   *
+   * @param id The catalog library id
+   * @returns `true` if it exists, otherwise `false`
+   *
+   * @examplePrompt Is this window still in the library?
+   * @examplePrompt Check whether a window catalog item with this id exists
+   * @examplePrompt Does my team library have this window?
+   * @examplePrompt Verify the window is available before placing it
+   *
+   * # Example
+   * ```ts
+   * const [entry] = await snaptrude.design.windows.listCatalog()
+   * const stillAvailable = await snaptrude.design.windows.exists(entry.id)
+   * console.log(stillAvailable ? "safe to place" : "removed from library")
+   * ```
+   */
+  public abstract exists(id: string): PluginApiReturn<boolean>
 }
 
 /**
@@ -205,3 +297,37 @@ export const PluginDesignWindowSetHeightArgs = z.object({
   height: z.number(),
 })
 export type PluginDesignWindowSetHeightArgs = z.infer<typeof PluginDesignWindowSetHeightArgs>
+
+// ---------------------------------------------------------------------------
+// catalog (shared DTOs defined in ../doors, re-exported here for symmetry)
+// ---------------------------------------------------------------------------
+
+// Re-export the shared catalog DTOs imported at the top of this file.
+export { PluginObjectCatalogGroup, PluginObjectCatalogItem }
+
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.listCatalog}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `group` | `string`? | Restrict to one group's `dbType` token (optional) |
+ */
+export const PluginDesignWindowListCatalogArgs = z.object({
+  group: z.string().optional(),
+})
+export type PluginDesignWindowListCatalogArgs = z.infer<typeof PluginDesignWindowListCatalogArgs>
+
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.getCatalogItem} / {@linkcode PluginDesignWindowsApi.exists}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The catalog library id |
+ */
+export const PluginDesignWindowGetCatalogItemArgs = z.object({
+  id: z.string(),
+})
+export type PluginDesignWindowGetCatalogItemArgs = z.infer<typeof PluginDesignWindowGetCatalogItemArgs>
+
+export const PluginDesignWindowExistsArgs = PluginDesignWindowGetCatalogItemArgs
+export type PluginDesignWindowExistsArgs = z.infer<typeof PluginDesignWindowExistsArgs>

package/src/api/entity/story.ts

@@ -1,5 +1,6 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../types"
+import { ComponentHandle } from "../../handles"
 
 /**
  * Story (floor/storey) management.
@@ -101,17 +102,25 @@ export abstract class PluginStoryApi {
   ): PluginApiReturn<PluginStoryCreateResult>
 
   /**
-   * Update a story's height.
+   * Update a story's floor-to-floor height, cascading the full geometry change.
    *
-   * Changes the floor-to-floor height of the specified story. This
-   * operation is undoable.
+   * This is the same operation as editing the height in the Stories panel: the
+   * walls, columns, and masses on the story are **stretched** to the new height,
+   * every story **above shifts up/down** by the delta so the stack stays
+   * contiguous, and coupled elements (staircases, parametric curtain walls,
+   * furniture offsets) are re-fitted. The whole cascade is committed as **one
+   * undo step**. Height-locked elements are left untouched.
    *
    * @param storyValue - Integer storey number
    *   identifying the story to update
-   * @param height - New height value in Babylon
-   *   units
+   * @param height - New floor-to-floor height in
+   *   Babylon units
    * @returns A {@linkcode PluginStoryUpdateResult} with the updated `storyValue` and `height`
-   * @throws If the story does not exist or the update fails
+   * @throws `PRECONDITION_FAILED` if no story has the given value;
+   *   `STORY_HEIGHT_REJECTED` if the engine rejects the height (e.g. out of
+   *   range — the change silently reverts host-side and is surfaced as this
+   *   error); `STORY_UPDATE_FAILED` if the story cannot be re-read after the
+   *   update
    *
    * @examplePrompt Change the ground floor height to 3.5 metres
    * @examplePrompt Make the second storey taller
@@ -120,7 +129,8 @@ export abstract class PluginStoryApi {
    *
    * # Example
    * ```ts
-   * // Set ground floor height to 5 Babylon units
+   * // Set ground floor height to 5 Babylon units — walls stretch and the
+   * // floors above move up to match, all in a single undo step.
    * const result = await snaptrude.entity.story.update(1, 5)
    * ```
    */
@@ -128,6 +138,54 @@ export abstract class PluginStoryApi {
     storyValue: number,
     height: number,
   ): PluginApiReturn<PluginStoryUpdateResult>
+
+  /**
+   * Duplicate a story into the adjacent level, up or down.
+   *
+   * By default the **whole story** is duplicated: every eligible element on the
+   * active story (walls, floors, roofs, masses, columns, beams, staircases,
+   * ceilings, parametric curtain walls, and furniture) is copied into the story
+   * one level `"up"` or `"down"`. Pass `options.components` to duplicate only a
+   * subset instead. The target story is **created automatically** if it does not
+   * yet exist, inheriting the source story's height.
+   *
+   * Copies are **instanced** by default (`unique: false`) — they share geometry
+   * with the source, so later edits propagate. Set `unique: true` for independent
+   * geometry. Doors and windows are never duplicated on their own; they ride along
+   * with their host wall. Locked, throw-away, and unsupported elements are skipped
+   * and counted in `skipped`. The whole operation is a single undo step.
+   *
+   * @param direction - `"up"` to duplicate into the story above, `"down"` for below
+   * @param options - `components` (restrict to a subset of the story's elements;
+   *   omit for the whole story) and `unique` (default `false` = instanced copies;
+   *   `true` = independent geometry)
+   * @returns A {@linkcode PluginStoryDuplicateResult} with the `sourceStory`, the
+   *   `targetStories` the copies landed on, the `created` component handles, the
+   *   `createdStoryValues` for any stories generated to receive them, and the
+   *   `skipped` count of ineligible elements
+   * @throws `NO_ACTIVE_STRUCTURE` if there is no active structure to duplicate
+   *   into; `NO_ELIGIBLE_ELEMENTS` if nothing on the source story (or in
+   *   `options.components`) is duplicable; `HANDLE_INVALID` for a stale or
+   *   foreign supplied handle; or if plugin writes are disabled
+   *
+   * @examplePrompt Duplicate this floor to the storey above
+   * @examplePrompt Copy the ground floor down into a new basement
+   * @examplePrompt Repeat this level upwards with its own independent geometry
+   * @examplePrompt Duplicate just the selected walls onto the next floor up
+   *
+   * # Example
+   * ```ts
+   * // Duplicate the whole active story one level up (instanced copies).
+   * const { targetStories, created, skipped } =
+   *   await snaptrude.entity.story.duplicate("up")
+   * console.log(`Copied ${created.length} elements onto story ${targetStories}`)
+   * if (skipped) console.log(`${skipped} elements were skipped`)
+   * ```
+   */
+  public abstract duplicate(
+    direction: "up" | "down",
+    options?: { components?: ComponentHandle[]; unique?: boolean },
+  ): PluginApiReturn<PluginStoryDuplicateResult>
 }
 
 /**
@@ -271,3 +329,43 @@ export const PluginStoryUpdateResult = z.object({
 })
 
 export type PluginStoryUpdateResult = z.infer<typeof PluginStoryUpdateResult>
+
+/**
+ * Arguments for {@linkcode PluginStoryApi.duplicate} (options flattened).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `direction` | `'up' \| 'down'` | Which adjacent story to duplicate into |
+ * | `components` | {@linkcode ComponentHandle}`[]?` | Restrict to a subset; omit for the whole story |
+ * | `unique` | `boolean?` | `false` (default) = instanced copies; `true` = independent geometry |
+ */
+export const PluginStoryDuplicateArgs = z.object({
+  direction: z.enum(["up", "down"]),
+  components: z.array(ComponentHandle).optional(),
+  unique: z.boolean().optional(),
+})
+
+export type PluginStoryDuplicateArgs = z.infer<typeof PluginStoryDuplicateArgs>
+
+/**
+ * Result of {@linkcode PluginStoryApi.duplicate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sourceStory` | `number` | Storey value the copies were duplicated from |
+ * | `targetStories` | `number[]` | Storey values the copies landed on |
+ * | `created` | {@linkcode ComponentHandle}`[]` | Handles of the newly created components |
+ * | `createdStoryValues` | `number[]` | Storey values that were generated to receive the copies |
+ * | `skipped` | `number` | Count of ineligible elements that were skipped |
+ */
+export const PluginStoryDuplicateResult = z.object({
+  sourceStory: z.number(),
+  targetStories: z.array(z.number()),
+  created: z.array(ComponentHandle),
+  createdStoryValues: z.array(z.number()),
+  skipped: z.number(),
+})
+
+export type PluginStoryDuplicateResult = z.infer<
+  typeof PluginStoryDuplicateResult
+>

package/src/api/presentation/import.ts

@@ -4,9 +4,10 @@ import { PluginApiReturn } from "../../types"
 /**
  * Presentation import — bring external reference assets onto the Present canvas.
  *
- * `import.image` places a reference image and `import.pdf` places a PDF (each
- * page vectorized to SVG) onto the current Present sheet, returning the created
- * canvas shape ids. Requires Present mode to be open.
+ * `import.image` places a reference image, `import.pdf` places a PDF (each
+ * page vectorized to SVG), and `import.svg` places a validated SVG onto
+ * the current Present sheet, returning the created canvas shape ids. Requires
+ * Present mode to be open.
  *
  * The host engine takes a browser `File`, which a plugin worker cannot supply,
  * so these accept a `url`/`dataUrl` that the host adapts into a `File`.
@@ -72,11 +73,51 @@ export abstract class PluginPresentationImportApi {
     source: { url?: string; dataUrl?: string },
     options?: { position?: { x: number; y: number } },
   ): PluginApiReturn<PluginPresentationImportResult>
+
+  /**
+   * Import an SVG onto the current Present sheet as a vector asset.
+   *
+   * An SVG-validating variant of {@linkcode PluginPresentationImportApi.image}:
+   * `import.image` already passes SVG sources through, but this method first
+   * validates that the source really is an SVG and forces the vector mime
+   * type. Throws if the source is not an SVG.
+   *
+   * **Rendering is vector up to a complexity cap.** Simple SVGs (up to ~1500
+   * SVG element nodes and ~2 MB) render true-vector and stay crisp at every
+   * zoom. Beyond that cap the shared canvas renderer **intentionally falls
+   * back to a 1920px raster** to protect canvas performance, so very complex
+   * SVGs can look rasterized when zoomed in. The stored asset is the original
+   * SVG either way; only the on-canvas rendering falls back.
+   *
+   * @param source - The SVG to import: exactly one of `url` or `dataUrl`.
+   * @param options - Optional `position` — where to place the SVG on the sheet.
+   * @returns A {@linkcode PluginPresentationImportResult} with the created
+   *   `shapeIds`.
+   * @throws If Present mode is not open, the source is not an SVG, or it cannot
+   *   be loaded.
+   *
+   * @examplePrompt Import this SVG diagram onto the present canvas
+   * @examplePrompt Add a vector logo to my presentation board
+   * @examplePrompt Place this SVG floor plan on the current sheet as vectors
+   * @examplePrompt Bring a crisp vector graphic into Present mode
+   *
+   * # Example
+   * ```ts
+   * const { shapeIds } = await snaptrude.presentation.import.svg({
+   *   url: "https://example.com/diagram.svg",
+   * })
+   * ```
+   */
+  public abstract svg(
+    source: { url?: string; dataUrl?: string },
+    options?: { position?: { x: number; y: number } },
+  ): PluginApiReturn<PluginPresentationImportResult>
 }
 
 /**
  * Arguments for {@linkcode PluginPresentationImportApi.image} /
- * {@linkcode PluginPresentationImportApi.pdf}. Provide exactly one source.
+ * {@linkcode PluginPresentationImportApi.pdf} /
+ * {@linkcode PluginPresentationImportApi.svg}. Provide exactly one source.
  *
  * | Property | Type | Description |
  * |---|---|---|

package/src/api/presentation/views.ts

@@ -6,12 +6,12 @@ import { PluginApiReturn } from "../../types"
  *
  * A **view** is a saved camera/plan: a sheet-ready 2D plan or a saved 3D view.
  * A plugin can list and read views, capture them to images, activate one (move
- * the camera to it), and save the current camera as a new view.
+ * the camera to it), save the current camera as a new view, and read/update a
+ * view's display settings (background, color mode, axis, edges, labels).
  *
- * `list`/`get`/`getActive`/`capture` are reads; `setActive`/`create` are writes
- * (a view is a camera bookmark — not geometry). Members typed optional (`?`) are
- * authored ahead of the host: declared for plugins/codegen but not yet on the
- * live discovery surface until the host lands them.
+ * `list`/`get`/`getActive`/`capture`/`getSettings` are reads;
+ * `setActive`/`create`/`updateSettings` are writes (a view is a camera bookmark
+ * — not geometry).
  *
  * Accessed via `snaptrude.presentation.views`.
  */
@@ -153,6 +153,85 @@ export abstract class PluginPresentationViewsApi {
     name?: string,
     options?: { kind?: "view" | "sitePlan" },
   ): PluginApiReturn<PluginPresentationViewsCreateResult>
+
+  /**
+   * Read a saved view's display settings (background, color mode, axis, edges,
+   * labels).
+   *
+   * @param viewId - The id of the view to read settings for.
+   * @returns The view's {@linkcode PluginPresentationViewSettings}, or `null` if
+   *   no view has that id.
+   *
+   * @examplePrompt What color mode is the Ground Floor view using?
+   * @examplePrompt Get the display settings for this view
+   * @examplePrompt Does the site plan view show axes and labels?
+   * @examplePrompt Read the background color of the active view
+   *
+   * # Example
+   * ```ts
+   * const settings = await snaptrude.presentation.views.getSettings("view_123")
+   * if (settings) console.log(settings.colorMode, settings.backgroundColor)
+   * ```
+   */
+  public abstract getSettings(
+    viewId: string,
+  ): PluginApiReturn<PluginPresentationViewsGetSettingsResult>
+
+  /**
+   * Update a saved view's display settings (partial patch — only the fields you
+   * pass change).
+   *
+   * Persists and broadcasts the change; if the view is currently active, the
+   * scene updates live. **Not Ctrl+Z-undoable** — view-metadata edits publish
+   * directly and do not land on the local undo stack; this matches how the
+   * product's own view-settings UI behaves.
+   *
+   * Label patch semantics (mirroring the product, which stores no label
+   * selection while labels are off):
+   *
+   * - `{ showLabels: true }` alone turns labels on; if the view has no stored
+   *   selection, the product defaults (`objectLabels`, `areas`) are applied —
+   *   labels are never "on" with an empty selection (the product has no such
+   *   state; labels render only while the selection is non-empty).
+   * - `{ labels: [...] }` alone sets the selection **and turns labels on**.
+   * - `{ showLabels: false }` turns labels off and **clears the stored
+   *   selection** — a later read returns `labels: []`.
+   * - `{ showLabels: false, labels: [...] }` with a non-empty list is
+   *   contradictory and **rejected** (nothing is silently discarded).
+   * - `{ showLabels: true, labels: [] }` is likewise contradictory and
+   *   **rejected** — pass a non-empty list, or omit `labels` to get the
+   *   defaults.
+   *
+   * `colorMode` accepts the `tag:<categoryId>` scheme strings returned by
+   * {@linkcode PluginPresentationViewsApi.getSettings}, so read-then-write
+   * round-trips a tag-based color scheme unchanged.
+   *
+   * @param viewId - The id of the view to update.
+   * @param settings - A partial {@linkcode PluginPresentationViewSettings}; any
+   *   omitted field is left unchanged.
+   * @returns The updated view's `id`.
+   * @throws If writes are disabled, no view has the given id, or the patch is
+   *   contradictory (`showLabels: false` with a non-empty `labels`, or
+   *   `showLabels: true` with an explicitly empty `labels` list).
+   *
+   * @examplePrompt Switch this view to monochrome color mode
+   * @examplePrompt Turn off the axis in the Ground Floor view
+   * @examplePrompt Set the background of the active view to white
+   * @examplePrompt Show area labels on this view
+   * @examplePrompt Enable hidden-line mode for the section view
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.presentation.views.updateSettings("view_123", {
+   *   colorMode: "monochrome",
+   *   showAxis: false,
+   * })
+   * ```
+   */
+  public abstract updateSettings(
+    viewId: string,
+    settings: Partial<PluginPresentationViewSettings>,
+  ): PluginApiReturn<PluginPresentationViewsUpdateSettingsResult>
 }
 
 /**
@@ -301,3 +380,140 @@ export const PluginPresentationViewsCreateResult = PluginPresentationView
 export type PluginPresentationViewsCreateResult = z.infer<
   typeof PluginPresentationViewsCreateResult
 >
+
+/**
+ * How the scene is colored in a view.
+ *
+ * | Value | Meaning |
+ * |---|---|
+ * | `monochrome` | Flat single-tone shading |
+ * | `texture` | Material textures/colors |
+ * | `department` | Colored by department |
+ * | `tag:<categoryId>` | Colored by a project tag category (e.g. `tag:ZONE`) |
+ *
+ * The `tag:<categoryId>` form carries the product's tag-based color schemes
+ * losslessly — reading a view that uses one returns the `tag:` string as-is,
+ * and writing it back preserves the scheme (read-then-write is safe).
+ */
+export const PluginPresentationViewColorMode = z.union([
+  z.enum(["monochrome", "texture", "department"]),
+  z.templateLiteral(["tag:", z.string()]),
+])
+export type PluginPresentationViewColorMode = z.infer<
+  typeof PluginPresentationViewColorMode
+>
+
+/**
+ * A category of on-canvas labels a view can show.
+ *
+ * | Value | Meaning |
+ * |---|---|
+ * | `objectLabels` | Per-object name labels |
+ * | `areas` | Area/room labels |
+ * | `department` | Department labels |
+ */
+export const PluginPresentationViewLabel = z.enum([
+  "objectLabels",
+  "areas",
+  "department",
+])
+export type PluginPresentationViewLabel = z.infer<
+  typeof PluginPresentationViewLabel
+>
+
+/**
+ * A view's display settings.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `backgroundColor` | `string` | Canvas background as a hex color (e.g. `#ffffff`) |
+ * | `colorMode` | {@linkcode PluginPresentationViewColorMode} | How the scene is colored (including `tag:<categoryId>` schemes) |
+ * | `showAxis` | `boolean` | Whether the X/Y/Z axes are shown |
+ * | `showEdges` | `boolean` | Whether edges are shown; `false` = hidden-line rendering |
+ * | `showLabels` | `boolean` | Master label switch — whether on-canvas labels are shown at all. `true` always pairs with a non-empty `labels` selection (labels render only while the selection is non-empty; there is no labels-on-with-empty-selection state) |
+ * | `labels` | {@linkcode PluginPresentationViewLabel}`[]` | Which label categories are selected. When `showLabels` is `false` the view stores no selection and this reads `[]` |
+ */
+export const PluginPresentationViewSettings = z.object({
+  backgroundColor: z.string(),
+  colorMode: PluginPresentationViewColorMode,
+  showAxis: z.boolean(),
+  showEdges: z.boolean(),
+  showLabels: z.boolean(),
+  labels: z.array(PluginPresentationViewLabel),
+})
+export type PluginPresentationViewSettings = z.infer<
+  typeof PluginPresentationViewSettings
+>
+
+/**
+ * Arguments for {@linkcode PluginPresentationViewsApi.getSettings}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the view to read settings for |
+ */
+export const PluginPresentationViewsGetSettingsArgs = z.object({
+  id: z.string(),
+})
+export type PluginPresentationViewsGetSettingsArgs = z.infer<
+  typeof PluginPresentationViewsGetSettingsArgs
+>
+
+/**
+ * Result of {@linkcode PluginPresentationViewsApi.getSettings} — the settings,
+ * or `null` when no view has that id.
+ */
+export const PluginPresentationViewsGetSettingsResult =
+  PluginPresentationViewSettings.nullable()
+export type PluginPresentationViewsGetSettingsResult = z.infer<
+  typeof PluginPresentationViewsGetSettingsResult
+>
+
+/**
+ * Arguments for {@linkcode PluginPresentationViewsApi.updateSettings}. The
+ * `settings` patch is partial — any omitted field is left unchanged. A patch
+ * pairing `showLabels: false` with a non-empty `labels` list, or
+ * `showLabels: true` with an explicitly empty `labels` list, is rejected as
+ * contradictory (see the method JSDoc for the full label patch semantics).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the view to update |
+ * | `settings` | `Partial<`{@linkcode PluginPresentationViewSettings}`>` | The fields to change |
+ */
+export const PluginPresentationViewsUpdateSettingsArgs = z
+  .object({
+    id: z.string(),
+    settings: PluginPresentationViewSettings.partial(),
+  })
+  .refine(
+    (v) =>
+      !(v.settings.showLabels === false && (v.settings.labels?.length ?? 0) > 0),
+    {
+      message:
+        "Contradictory patch: labels cannot be set while showLabels is false",
+    },
+  )
+  .refine(
+    (v) =>
+      !(
+        v.settings.showLabels === true &&
+        v.settings.labels !== undefined &&
+        v.settings.labels.length === 0
+      ),
+    {
+      message:
+        "Contradictory patch: showLabels cannot be true with an explicitly empty labels list — pass a non-empty list, or omit labels to apply the defaults",
+    },
+  )
+export type PluginPresentationViewsUpdateSettingsArgs = z.infer<
+  typeof PluginPresentationViewsUpdateSettingsArgs
+>
+
+/** Result of {@linkcode PluginPresentationViewsApi.updateSettings} — the updated view's id. */
+export const PluginPresentationViewsUpdateSettingsResult = z.object({
+  id: z.string(),
+})
+export type PluginPresentationViewsUpdateSettingsResult = z.infer<
+  typeof PluginPresentationViewsUpdateSettingsResult
+>