@snaptrude/plugin-core 0.3.0 → 0.6.0

package/src/api/core/layers.ts

@@ -0,0 +1,333 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+
+/**
+ * Layers — read and toggle the drawing/reference layers of a storey.
+ *
+ * These are the **drawing/reference** layers shown in the storey's Layers panel —
+ * the surfaces you sketch on and the imported underlays (CAD, PDF, images,
+ * terrain). They are **not** wall/floor construction-assembly material layers,
+ * which are a property of the built element, not this namespace.
+ *
+ * Reads return plain records and never throw for a missing layer (`get` and
+ * `getActive` return `null`, `list` returns `[]`).
+ *
+ * v1 exposes reads plus visibility edits and the active-layer switch.
+ * Creating and deleting layers are intentionally not part of this contract yet.
+ *
+ * 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.layers`.
+ */
+export abstract class PluginCoreLayersApi {
+  constructor() {}
+
+  /**
+   * List the drawing layers of a storey.
+   *
+   * Optionally filter to a single {@linkcode PluginCoreLayerType}.
+   *
+   * @param storeyId - The storey whose layers to read.
+   * @param layerType - Optional {@linkcode PluginCoreLayerType} filter.
+   * @returns A {@linkcode PluginCoreLayersListResult} with a `layers` array
+   *   (empty when the storey is missing or has no matching layers).
+   *
+   * @examplePrompt List the drawing layers 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.layers.list("st_2")
+   * for (const l of layers) console.log(l.name, l.layerType, l.hidden)
+   * ```
+   */
+  public abstract list(
+    storeyId: string,
+    layerType?: PluginCoreLayerType,
+  ): PluginApiReturn<PluginCoreLayersListResult>
+
+  /**
+   * Get a single drawing layer by id.
+   *
+   * @param layerId - The id of the layer to read.
+   * @returns The matching {@linkcode PluginCoreLayer}, or `null` if no layer has
+   *   that id.
+   *
+   * @examplePrompt Get the drawing layer with id ly_5
+   * @examplePrompt Is layer ly_5 hidden or locked?
+   * @examplePrompt Look up a single drawing layer by its id
+   *
+   * # Example
+   * ```ts
+   * const layer = await snaptrude.core.layers.get("ly_5")
+   * if (layer) console.log(layer.name, layer.hidden, layer.locked)
+   * ```
+   */
+  public abstract get(
+    layerId: string,
+  ): PluginApiReturn<PluginCoreLayersGetResult>
+
+  /**
+   * Get the active drawing layer of a storey.
+   *
+   * The active layer is the one new sketch geometry is drawn onto. Paired with
+   * {@linkcode PluginCoreLayersApi.setActive}.
+   *
+   * @param storeyId - The storey whose active layer to read.
+   * @returns The active {@linkcode PluginCoreLayer}, or `null` if the storey is
+   *   missing or has no active layer.
+   *
+   * @examplePrompt Which drawing layer is active on this storey?
+   * @examplePrompt Get the current layer on storey st_2
+   * @examplePrompt What layer am I drawing on?
+   *
+   * # Example
+   * ```ts
+   * const active = await snaptrude.core.layers.getActive("st_2")
+   * if (active) console.log(active.name)
+   * ```
+   */
+  public abstract getActive(
+    storeyId: string,
+  ): PluginApiReturn<PluginCoreLayersGetActiveResult>
+
+  /**
+   * Make a drawing layer the active layer of its storey.
+   *
+   * Paired with {@linkcode PluginCoreLayersApi.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 Draw on layer ly_5
+   * @examplePrompt Make this the active layer
+   * @examplePrompt Switch the active layer to the CAD underlay
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.core.layers.setActive("ly_5")
+   * ```
+   */
+  public abstract setActive(
+    layerId: string,
+  ): PluginApiReturn<PluginCoreLayersSetActiveResult>
+
+  /**
+   * Update a drawing 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
+   * flip the panel padlock 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 PluginCoreLayer}.
+   * @throws If no layer has the given id.
+   *
+   * @examplePrompt Hide the PDF underlay layer
+   * @examplePrompt Show the CAD layer again
+   * @examplePrompt Hide layer ly_5
+   *
+   * # Example
+   * ```ts
+   * const layer = await snaptrude.core.layers.update("ly_5", true)
+   * ```
+   */
+  public abstract update(
+    layerId: string,
+    hidden?: boolean,
+  ): PluginApiReturn<PluginCoreLayersUpdateResult>
+}
+
+/**
+ * The kind of a drawing layer.
+ *
+ * Author-drawable kinds (`floor`, `wall`, `ceiling`, `rough`, `default`) plus
+ * read-only imported underlays (`image`, `cad`, `pdf`, `terrain`, `buildings`).
+ */
+export const PluginCoreLayerType = z.enum([
+  "floor",
+  "wall",
+  "ceiling",
+  "rough",
+  "default",
+  "image",
+  "cad",
+  "pdf",
+  "terrain",
+  "buildings",
+])
+export type PluginCoreLayerType = z.infer<typeof PluginCoreLayerType>
+
+/**
+ * A drawing/reference layer on a storey.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Stable public layer id (e.g. `"ly_5"`) |
+ * | `name` | `string` | Display name |
+ * | `layerType` | {@linkcode PluginCoreLayerType} | 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 PluginCoreLayer = z.object({
+  id: z.string(),
+  name: z.string(),
+  layerType: PluginCoreLayerType,
+  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 PluginCoreLayer = z.infer<typeof PluginCoreLayer>
+
+/**
+ * Arguments for {@linkcode PluginCoreLayersApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeyId` | `string` | The storey whose layers to read |
+ * | `layerType` | {@linkcode PluginCoreLayerType}` \| undefined` | Optional layer-type filter |
+ */
+export const PluginCoreLayersListArgs = z.object({
+  storeyId: z.string(),
+  layerType: PluginCoreLayerType.optional(),
+})
+export type PluginCoreLayersListArgs = z.infer<
+  typeof PluginCoreLayersListArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreLayersApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layers` | {@linkcode PluginCoreLayer}`[]` | The storey's drawing layers (empty when missing or none match) |
+ */
+export const PluginCoreLayersListResult = z.object({
+  layers: z.array(PluginCoreLayer),
+})
+export type PluginCoreLayersListResult = z.infer<
+  typeof PluginCoreLayersListResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreLayersApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the layer to read |
+ */
+export const PluginCoreLayersGetArgs = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreLayersGetArgs = z.infer<
+  typeof PluginCoreLayersGetArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreLayersApi.get} — the layer, or `null`
+ * when no layer has the given id.
+ */
+export const PluginCoreLayersGetResult = PluginCoreLayer.nullable()
+export type PluginCoreLayersGetResult = z.infer<
+  typeof PluginCoreLayersGetResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreLayersApi.getActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeyId` | `string` | The storey whose active layer to read |
+ */
+export const PluginCoreLayersGetActiveArgs = z.object({
+  storeyId: z.string(),
+})
+export type PluginCoreLayersGetActiveArgs = z.infer<
+  typeof PluginCoreLayersGetActiveArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreLayersApi.getActive} — the active layer,
+ * or `null` when the storey is missing or has no active layer.
+ */
+export const PluginCoreLayersGetActiveResult = PluginCoreLayer.nullable()
+export type PluginCoreLayersGetActiveResult = z.infer<
+  typeof PluginCoreLayersGetActiveResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreLayersApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the layer to activate |
+ */
+export const PluginCoreLayersSetActiveArgs = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreLayersSetActiveArgs = z.infer<
+  typeof PluginCoreLayersSetActiveArgs
+>
+
+/**
+ * Result of {@linkcode PluginCoreLayersApi.setActive} — the now-active
+ * layer's id.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `layerId` | `string` | The id of the now-active layer |
+ */
+export const PluginCoreLayersSetActiveResult = z.object({
+  layerId: z.string(),
+})
+export type PluginCoreLayersSetActiveResult = z.infer<
+  typeof PluginCoreLayersSetActiveResult
+>
+
+/**
+ * Arguments for {@linkcode PluginCoreLayersApi.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 PluginCoreLayersUpdateArgs = z.object({
+  layerId: z.string(),
+  hidden: z.boolean().optional(),
+})
+export type PluginCoreLayersUpdateArgs = z.infer<
+  typeof PluginCoreLayersUpdateArgs
+>
+
+/** Result of {@linkcode PluginCoreLayersApi.update} — the updated layer. */
+export const PluginCoreLayersUpdateResult = PluginCoreLayer
+export type PluginCoreLayersUpdateResult = z.infer<
+  typeof PluginCoreLayersUpdateResult
+>