@snaptrude/plugin-core 0.9.17 → 0.9.18-networks-20261016.1

package/src/api/core/storeys/layers.ts

@@ -1,339 +1,339 @@
-import * as z from "zod"
-import { PluginApiReturn } from "../../../types"
-
-/**
- * Storey layers — read and toggle a storey's sketch surfaces and imported
- * underlays.
- *
- * These are each storey's built-in sketch surfaces (Wall, Rough) and its
- * imported underlays (CAD, PDF, images, terrain, neighbourhood buildings), with
- * ids like `ly_5`. They are **NOT** the layers in the product's Layers panel in
- * the left sidebar; use {@linkcode PluginCoreLayersApi} (`core.layers`) for
- * those. They are also not wall/floor construction-assembly material layers.
- *
- * Reads return plain records and never throw for a missing layer (`get` and
- * `getActive` return `null`, `list` returns `[]`).
- *
- * Storey layers are created only by storey creation and `core.io.import.*`;
- * delete underlays with `core.io.underlay.delete` / `core.io.terrain.delete`.
- *
- * 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.storeys.layers` (formerly `core.layers`).
- *
- * Formerly `core.layers`. Calls in that shape on `core.layers` (`list(storeyId)`,
- * `getActive(storeyId)`, `get` / `setActive` / `update(layerId, hidden)` with a
- * `ly_*` id) are still routed here, so plugins built before 0.9.15 keep working.
- */
-export abstract class PluginCoreStoreysLayersApi {
-  constructor() {}
-
-  /**
-   * List the storey layers of a storey.
-   *
-   * Optionally filter to a single {@linkcode PluginCoreStoreyLayerType}.
-   *
-   * @param storeyId - The storey whose layers to read.
-   * @param layerType - Optional {@linkcode PluginCoreStoreyLayerType} filter.
-   * @returns A {@linkcode PluginCoreStoreysLayersListResult} with a `layers` array
-   *   (empty when the storey is missing or has no matching layers).
-   *
-   * @examplePrompt List the sketch surfaces and underlays on this storey
-   * @examplePrompt Show all the PDF underlays on storey st_2
-   * @examplePrompt What CAD layers are on the ground floor?
-   *
-   * # Example
-   * ```ts
-   * const { layers } = await snaptrude.core.storeys.layers.list("st_2")
-   * for (const l of layers) console.log(l.name, l.layerType, l.hidden)
-   * ```
-   */
-  public abstract list(
-    storeyId: string,
-    layerType?: PluginCoreStoreyLayerType,
-  ): PluginApiReturn<PluginCoreStoreysLayersListResult>
-
-  /**
-   * Get a single storey layer by id.
-   *
-   * @param layerId - The id of the layer to read.
-   * @returns The matching {@linkcode PluginCoreStoreyLayer}, or `null` if no layer has
-   *   that id.
-   *
-   * @examplePrompt Get the storey drawing layer with id ly_5
-   * @examplePrompt Is storey layer ly_5 hidden?
-   * @examplePrompt Look up a storey underlay layer by id
-   *
-   * # Example
-   * ```ts
-   * const layer = await snaptrude.core.storeys.layers.get("ly_5")
-   * if (layer) console.log(layer.name, layer.hidden, layer.locked)
-   * ```
-   */
-  public abstract get(
-    layerId: string,
-  ): PluginApiReturn<PluginCoreStoreysLayersGetResult>
-
-  /**
-   * Get the active storey layer of a storey.
-   *
-   * The active layer is the one new sketch geometry is drawn onto. Paired with
-   * {@linkcode PluginCoreStoreysLayersApi.setActive}.
-   *
-   * @param storeyId - The storey whose active layer to read.
-   * @returns The active {@linkcode PluginCoreStoreyLayer}, or `null` if the storey is
-   *   missing or has no active layer.
-   *
-   * @examplePrompt Which sketch surface (Wall/Rough) is active on this storey?
-   * @examplePrompt Get the active storey drawing layer on st_2
-   * @examplePrompt Which storey layer is new sketch geometry drawn onto?
-   *
-   * # Example
-   * ```ts
-   * const active = await snaptrude.core.storeys.layers.getActive("st_2")
-   * if (active) console.log(active.name)
-   * ```
-   */
-  public abstract getActive(
-    storeyId: string,
-  ): PluginApiReturn<PluginCoreStoreysLayersGetActiveResult>
-
-  /**
-   * Make a storey layer the active layer of its storey.
-   *
-   * Paired with {@linkcode PluginCoreStoreysLayersApi.getActive}.
-   *
-   * @param layerId - The id of the layer to activate.
-   * @returns The id of the now-active layer.
-   * @throws If no layer has the given id.
-   *
-   * @examplePrompt Switch this storey's sketch surface to the Rough layer
-   * @examplePrompt Make storey layer ly_5 the active sketch surface
-   * @examplePrompt Switch the active storey layer to the CAD underlay
-   *
-   * # Example
-   * ```ts
-   * await snaptrude.core.storeys.layers.setActive("ly_5")
-   * ```
-   */
-  public abstract setActive(
-    layerId: string,
-  ): PluginApiReturn<PluginCoreStoreysLayersSetActiveResult>
-
-  /**
-   * Update a storey layer's visibility.
-   *
-   * A **sparse** update: omit `hidden` to leave it unchanged. This edit is **not
-   * undoable**. Locking and renaming are not exposed — layer `locked` is a
-   * read-only status here (setting it at runtime does not lock the live meshes or
-   * show a padlock in the app until a reload), and a rename cascades to every member
-   * mesh's `layerName`, a corruption hazard.
-   *
-   * @param layerId - The id of the layer to update.
-   * @param hidden - New hidden state (unchanged if omitted).
-   * @returns The updated {@linkcode PluginCoreStoreyLayer}.
-   * @throws If no layer has the given id.
-   *
-   * @examplePrompt Hide the PDF underlay layer
-   * @examplePrompt Show the CAD underlay again
-   * @examplePrompt Hide storey layer ly_5
-   *
-   * # Example
-   * ```ts
-   * const layer = await snaptrude.core.storeys.layers.update("ly_5", true)
-   * ```
-   */
-  public abstract update(
-    layerId: string,
-    hidden?: boolean,
-  ): PluginApiReturn<PluginCoreStoreysLayersUpdateResult>
-}
-
-/**
- * The kind of a storey layer.
- *
- * Author-drawable kinds (`floor`, `wall`, `ceiling`, `rough`, `default`) plus
- * read-only imported underlays (`image`, `cad`, `pdf`, `terrain`, `buildings`).
- */
-export const PluginCoreStoreyLayerType = z.enum([
-  "floor",
-  "wall",
-  "ceiling",
-  "rough",
-  "default",
-  "image",
-  "cad",
-  "pdf",
-  "terrain",
-  "buildings",
-])
-export type PluginCoreStoreyLayerType = z.infer<typeof PluginCoreStoreyLayerType>
-
-/**
- * A storey layer on a storey.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `id` | `string` | Stable public layer id (e.g. `"ly_5"`) |
- * | `name` | `string` | Display name |
- * | `layerType` | {@linkcode PluginCoreStoreyLayerType} | The layer's kind |
- * | `storeyId` | `string` | The stable id of the storey this layer belongs to |
- * | `buildingId` | `string` | The stable id of the building this layer belongs to |
- * | `hidden` | `boolean` | Whether the layer is hidden |
- * | `locked` | `boolean` | Whether the layer is locked against edits |
- * | `contentSummary` | `object` | A summary of what the layer holds (see below) |
- *
- * `contentSummary`:
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `hasFloorplan` | `boolean` | Whether the layer holds drawn floorplan geometry |
- * | `pdfCount` | `number` | Number of PDF underlays on the layer |
- * | `hasTerrain` | `boolean` | Whether the layer holds terrain |
- */
-export const PluginCoreStoreyLayer = z.object({
-  id: z.string(),
-  name: z.string(),
-  layerType: PluginCoreStoreyLayerType,
-  storeyId: z.string(),
-  buildingId: z.string(),
-  hidden: z.boolean(),
-  locked: z.boolean(),
-  contentSummary: z.object({
-    hasFloorplan: z.boolean(),
-    pdfCount: z.number().int(),
-    hasTerrain: z.boolean(),
-  }),
-})
-export type PluginCoreStoreyLayer = z.infer<typeof PluginCoreStoreyLayer>
-
-/**
- * Arguments for {@linkcode PluginCoreStoreysLayersApi.list}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `storeyId` | `string` | The storey whose layers to read |
- * | `layerType` | {@linkcode PluginCoreStoreyLayerType}` \| undefined` | Optional layer-type filter |
- */
-export const PluginCoreStoreysLayersListArgs = z.object({
-  storeyId: z.string(),
-  layerType: PluginCoreStoreyLayerType.optional(),
-})
-export type PluginCoreStoreysLayersListArgs = z.infer<
-  typeof PluginCoreStoreysLayersListArgs
->
-
-/**
- * Result of {@linkcode PluginCoreStoreysLayersApi.list}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `layers` | {@linkcode PluginCoreStoreyLayer}`[]` | The storey's storey layers (empty when missing or none match) |
- */
-export const PluginCoreStoreysLayersListResult = z.object({
-  layers: z.array(PluginCoreStoreyLayer),
-})
-export type PluginCoreStoreysLayersListResult = z.infer<
-  typeof PluginCoreStoreysLayersListResult
->
-
-/**
- * Arguments for {@linkcode PluginCoreStoreysLayersApi.get}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `layerId` | `string` | The id of the layer to read |
- */
-export const PluginCoreStoreysLayersGetArgs = z.object({
-  layerId: z.string(),
-})
-export type PluginCoreStoreysLayersGetArgs = z.infer<
-  typeof PluginCoreStoreysLayersGetArgs
->
-
-/**
- * Result of {@linkcode PluginCoreStoreysLayersApi.get} — the layer, or `null`
- * when no layer has the given id.
- */
-export const PluginCoreStoreysLayersGetResult = PluginCoreStoreyLayer.nullable()
-export type PluginCoreStoreysLayersGetResult = z.infer<
-  typeof PluginCoreStoreysLayersGetResult
->
-
-/**
- * Arguments for {@linkcode PluginCoreStoreysLayersApi.getActive}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `storeyId` | `string` | The storey whose active layer to read |
- */
-export const PluginCoreStoreysLayersGetActiveArgs = z.object({
-  storeyId: z.string(),
-})
-export type PluginCoreStoreysLayersGetActiveArgs = z.infer<
-  typeof PluginCoreStoreysLayersGetActiveArgs
->
-
-/**
- * Result of {@linkcode PluginCoreStoreysLayersApi.getActive} — the active layer,
- * or `null` when the storey is missing or has no active layer.
- */
-export const PluginCoreStoreysLayersGetActiveResult = PluginCoreStoreyLayer.nullable()
-export type PluginCoreStoreysLayersGetActiveResult = z.infer<
-  typeof PluginCoreStoreysLayersGetActiveResult
->
-
-/**
- * Arguments for {@linkcode PluginCoreStoreysLayersApi.setActive}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `layerId` | `string` | The id of the layer to activate |
- */
-export const PluginCoreStoreysLayersSetActiveArgs = z.object({
-  layerId: z.string(),
-})
-export type PluginCoreStoreysLayersSetActiveArgs = z.infer<
-  typeof PluginCoreStoreysLayersSetActiveArgs
->
-
-/**
- * Result of {@linkcode PluginCoreStoreysLayersApi.setActive} — the now-active
- * layer's id.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `layerId` | `string` | The id of the now-active layer |
- */
-export const PluginCoreStoreysLayersSetActiveResult = z.object({
-  layerId: z.string(),
-})
-export type PluginCoreStoreysLayersSetActiveResult = z.infer<
-  typeof PluginCoreStoreysLayersSetActiveResult
->
-
-/**
- * Arguments for {@linkcode PluginCoreStoreysLayersApi.update}. Sparse — only the
- * provided fields are changed.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `layerId` | `string` | The id of the layer to update |
- * | `hidden` | `boolean \| undefined` | New hidden state (unchanged if omitted) |
- */
-export const PluginCoreStoreysLayersUpdateArgs = z.object({
-  layerId: z.string(),
-  hidden: z.boolean().optional(),
-})
-export type PluginCoreStoreysLayersUpdateArgs = z.infer<
-  typeof PluginCoreStoreysLayersUpdateArgs
->
-
-/** Result of {@linkcode PluginCoreStoreysLayersApi.update} — the updated layer. */
-export const PluginCoreStoreysLayersUpdateResult = PluginCoreStoreyLayer
-export type PluginCoreStoreysLayersUpdateResult = z.infer<
-  typeof PluginCoreStoreysLayersUpdateResult
->
+import * as z from "zod"
+import { PluginApiReturn } from "../../../types"
+
+/**
+ * Storey layers — read and toggle a storey's sketch surfaces and imported
+ * underlays.
+ *
+ * These are each storey's built-in sketch surfaces (Wall, Rough) and its
+ * imported underlays (CAD, PDF, images, terrain, neighbourhood buildings), with
+ * ids like `ly_5`. They are **NOT** the layers in the product's Layers panel in
+ * the left sidebar; use {@linkcode PluginCoreLayersApi} (`core.layers`) for
+ * those. They are also not wall/floor construction-assembly material layers.
+ *
+ * Reads return plain records and never throw for a missing layer (`get` and
+ * `getActive` return `null`, `list` returns `[]`).
+ *
+ * Storey layers are created only by storey creation and `core.io.import.*`;
+ * delete underlays with `core.io.underlay.delete` / `core.io.terrain.delete`.
+ *
+ * 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.storeys.layers` (formerly `core.layers`).
+ *
+ * Formerly `core.layers`. Calls in that shape on `core.layers` (`list(storeyId)`,
+ * `getActive(storeyId)`, `get` / `setActive` / `update(layerId, hidden)` with a
+ * `ly_*` id) are still routed here, so plugins built before 0.9.15 keep working.
+ */
+export abstract class PluginCoreStoreysLayersApi {
+  constructor() {}
+
+  /**
+   * List the storey layers of a storey.
+   *
+   * Optionally filter to a single {@linkcode PluginCoreStoreyLayerType}.
+   *
+   * @param storeyId - The storey whose layers to read.
+   * @param layerType - Optional {@linkcode PluginCoreStoreyLayerType} filter.
+   * @returns A {@linkcode PluginCoreStoreysLayersListResult} with a `layers` array
+   *   (empty when the storey is missing or has no matching layers).
+   *
+   * @examplePrompt List the sketch surfaces and underlays on this storey
+   * @examplePrompt Show all the PDF underlays on storey st_2
+   * @examplePrompt What CAD layers are on the ground floor?
+   *
+   * # Example
+   * ```ts
+   * const { layers } = await snaptrude.core.storeys.layers.list("st_2")
+   * for (const l of layers) console.log(l.name, l.layerType, l.hidden)
+   * ```
+   */
+  public abstract list(
+    storeyId: string,
+    layerType?: PluginCoreStoreyLayerType,
+  ): PluginApiReturn<PluginCoreStoreysLayersListResult>
+
+  /**
+   * Get a single storey layer by id.
+   *
+   * @param layerId - The id of the layer to read.
+   * @returns The matching {@linkcode PluginCoreStoreyLayer}, or `null` if no layer has
+   *   that id.
+   *
+   * @examplePrompt Get the storey drawing layer with id ly_5
+   * @examplePrompt Is storey layer ly_5 hidden?
+   * @examplePrompt Look up a storey underlay layer by id
+   *
+   * # Example
+   * ```ts
+   * const layer = await snaptrude.core.storeys.layers.get("ly_5")
+   * if (layer) console.log(layer.name, layer.hidden, layer.locked)
+   * ```
+   */
+  public abstract get(
+    layerId: string,
+  ): PluginApiReturn<PluginCoreStoreysLayersGetResult>
+
+  /**
+   * Get the active storey layer of a storey.
+   *
+   * The active layer is the one new sketch geometry is drawn onto. Paired with
+   * {@linkcode PluginCoreStoreysLayersApi.setActive}.
+   *
+   * @param storeyId - The storey whose active layer to read.
+   * @returns The active {@linkcode PluginCoreStoreyLayer}, or `null` if the storey is
+   *   missing or has no active layer.
+   *
+   * @examplePrompt Which sketch surface (Wall/Rough) is active on this storey?
+   * @examplePrompt Get the active storey drawing layer on st_2
+   * @examplePrompt Which storey layer is new sketch geometry drawn onto?
+   *
+   * # Example
+   * ```ts
+   * const active = await snaptrude.core.storeys.layers.getActive("st_2")
+   * if (active) console.log(active.name)
+   * ```
+   */
+  public abstract getActive(
+    storeyId: string,
+  ): PluginApiReturn<PluginCoreStoreysLayersGetActiveResult>
+
+  /**
+   * Make a storey layer the active layer of its storey.
+   *
+   * Paired with {@linkcode PluginCoreStoreysLayersApi.getActive}.
+   *
+   * @param layerId - The id of the layer to activate.
+   * @returns The id of the now-active layer.
+   * @throws If no layer has the given id.
+   *
+   * @examplePrompt Switch this storey's sketch surface to the Rough layer
+   * @examplePrompt Make storey layer ly_5 the active sketch surface
+   * @examplePrompt Switch the active storey layer to the CAD underlay
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.core.storeys.layers.setActive("ly_5")
+   * ```
+   */
+  public abstract setActive(
+    layerId: string,
+  ): PluginApiReturn<PluginCoreStoreysLayersSetActiveResult>
+
+  /**
+   * Update a storey layer's visibility.
+   *
+   * A **sparse** update: omit `hidden` to leave it unchanged. This edit is **not
+   * undoable**. Locking and renaming are not exposed — layer `locked` is a
+   * read-only status here (setting it at runtime does not lock the live meshes or
+   * show a padlock in the app until a reload), and a rename cascades to every member
+   * mesh's `layerName`, a corruption hazard.
+   *
+   * @param layerId - The id of the layer to update.
+   * @param hidden - New hidden state (unchanged if omitted).
+   * @returns The updated {@linkcode PluginCoreStoreyLayer}.
+   * @throws If no layer has the given id.
+   *
+   * @examplePrompt Hide the PDF underlay layer
+   * @examplePrompt Show the CAD underlay again
+   * @examplePrompt Hide storey layer ly_5
+   *
+   * # Example
+   * ```ts
+   * const layer = await snaptrude.core.storeys.layers.update("ly_5", true)
+   * ```
+   */
+  public abstract update(
+    layerId: string,
+    hidden?: boolean,
+  ): PluginApiReturn<PluginCoreStoreysLayersUpdateResult>
+}
+
+/**
+ * The kind of a storey layer.
+ *
+ * Author-drawable kinds (`floor`, `wall`, `ceiling`, `rough`, `default`) plus
+ * read-only imported underlays (`image`, `cad`, `pdf`, `terrain`, `buildings`).
+ */
+export const PluginCoreStoreyLayerType = z.enum([
+  "floor",
+  "wall",
+  "ceiling",
+  "rough",
+  "default",
+  "image",
+  "cad",
+  "pdf",
+  "terrain",
+  "buildings",
+])
+export type PluginCoreStoreyLayerType = z.infer<typeof PluginCoreStoreyLayerType>
+
+/**
+ * A storey layer on a storey.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Stable public layer id (e.g. `"ly_5"`) |
+ * | `name` | `string` | Display name |
+ * | `layerType` | {@linkcode PluginCoreStoreyLayerType} | The layer's kind |
+ * | `storeyId` | `string` | The stable id of the storey this layer belongs to |
+ * | `buildingId` | `string` | The stable id of the building this layer belongs to |
+ * | `hidden` | `boolean` | Whether the layer is hidden |
+ * | `locked` | `boolean` | Whether the layer is locked against edits |
+ * | `contentSummary` | `object` | A summary of what the layer holds (see below) |
+ *
+ * `contentSummary`:
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `hasFloorplan` | `boolean` | Whether the layer holds drawn floorplan geometry |
+ * | `pdfCount` | `number` | Number of PDF underlays on the layer |
+ * | `hasTerrain` | `boolean` | Whether the layer holds terrain |
+ */
+export const PluginCoreStoreyLayer = z.object({
+  id: z.string(),
+  name: z.string(),
+  layerType: PluginCoreStoreyLayerType,
+  storeyId: z.string(),
+  buildingId: z.string(),
+  hidden: z.boolean(),
+  locked: z.boolean(),
+  contentSummary: z.object({
+    hasFloorplan: z.boolean(),
+    pdfCount: z.number().int(),
+    hasTerrain: z.boolean(),
+  }),
+})
+export type PluginCoreStoreyLayer = z.infer<typeof PluginCoreStoreyLayer>
+
+/**
+ * Arguments for {@linkcode PluginCoreStoreysLayersApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeyId` | `string` | The storey whose layers to read |
+ * | `layerType` | {@linkcode PluginCoreStoreyLayerType}` \| undefined` | Optional layer-type filter |
+ */
+export const PluginCoreStoreysLayersListArgs = z.object({
+  storeyId: z.string(),
+  layerType: PluginCoreStoreyLayerType.optional(),
+})
+export type PluginCoreStoreysLayersListArgs = z.infer<
+  typeof PluginCoreStoreysLayersListArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreStoreysLayersApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layers` | {@linkcode PluginCoreStoreyLayer}`[]` | The storey's storey layers (empty when missing or none match) |
+ */
+export const PluginCoreStoreysLayersListResult = z.object({
+  layers: z.array(PluginCoreStoreyLayer),
+})
+export type PluginCoreStoreysLayersListResult = z.infer<
+  typeof PluginCoreStoreysLayersListResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreStoreysLayersApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the layer to read |
+ */
+export const PluginCoreStoreysLayersGetArgs = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreStoreysLayersGetArgs = z.infer<
+  typeof PluginCoreStoreysLayersGetArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreStoreysLayersApi.get} — the layer, or `null`
+ * when no layer has the given id.
+ */
+export const PluginCoreStoreysLayersGetResult = PluginCoreStoreyLayer.nullable()
+export type PluginCoreStoreysLayersGetResult = z.infer<
+  typeof PluginCoreStoreysLayersGetResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreStoreysLayersApi.getActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeyId` | `string` | The storey whose active layer to read |
+ */
+export const PluginCoreStoreysLayersGetActiveArgs = z.object({
+  storeyId: z.string(),
+})
+export type PluginCoreStoreysLayersGetActiveArgs = z.infer<
+  typeof PluginCoreStoreysLayersGetActiveArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreStoreysLayersApi.getActive} — the active layer,
+ * or `null` when the storey is missing or has no active layer.
+ */
+export const PluginCoreStoreysLayersGetActiveResult = PluginCoreStoreyLayer.nullable()
+export type PluginCoreStoreysLayersGetActiveResult = z.infer<
+  typeof PluginCoreStoreysLayersGetActiveResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreStoreysLayersApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the layer to activate |
+ */
+export const PluginCoreStoreysLayersSetActiveArgs = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreStoreysLayersSetActiveArgs = z.infer<
+  typeof PluginCoreStoreysLayersSetActiveArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreStoreysLayersApi.setActive} — the now-active
+ * layer's id.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the now-active layer |
+ */
+export const PluginCoreStoreysLayersSetActiveResult = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreStoreysLayersSetActiveResult = z.infer<
+  typeof PluginCoreStoreysLayersSetActiveResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreStoreysLayersApi.update}. Sparse — only the
+ * provided fields are changed.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the layer to update |
+ * | `hidden` | `boolean \| undefined` | New hidden state (unchanged if omitted) |
+ */
+export const PluginCoreStoreysLayersUpdateArgs = z.object({
+  layerId: z.string(),
+  hidden: z.boolean().optional(),
+})
+export type PluginCoreStoreysLayersUpdateArgs = z.infer<
+  typeof PluginCoreStoreysLayersUpdateArgs
+>
+
+/** Result of {@linkcode PluginCoreStoreysLayersApi.update} — the updated layer. */
+export const PluginCoreStoreysLayersUpdateResult = PluginCoreStoreyLayer
+export type PluginCoreStoreysLayersUpdateResult = z.infer<
+  typeof PluginCoreStoreysLayersUpdateResult
+>