@snaptrude/plugin-core 0.10.0 → 1.0.0

package/dist/api/core/storeys/layers.d.ts

@@ -0,0 +1,408 @@
+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 declare 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)
+     * ```
+     */
+    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)
+     * ```
+     */
+    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)
+     * ```
+     */
+    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")
+     * ```
+     */
+    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)
+     * ```
+     */
+    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 declare const PluginCoreStoreyLayerType: z.ZodEnum<{
+    default: "default";
+    terrain: "terrain";
+    buildings: "buildings";
+    cad: "cad";
+    floor: "floor";
+    wall: "wall";
+    ceiling: "ceiling";
+    rough: "rough";
+    image: "image";
+    pdf: "pdf";
+}>;
+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 declare const PluginCoreStoreyLayer: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    layerType: z.ZodEnum<{
+        default: "default";
+        terrain: "terrain";
+        buildings: "buildings";
+        cad: "cad";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        rough: "rough";
+        image: "image";
+        pdf: "pdf";
+    }>;
+    storeyId: z.ZodString;
+    buildingId: z.ZodString;
+    hidden: z.ZodBoolean;
+    locked: z.ZodBoolean;
+    contentSummary: z.ZodObject<{
+        hasFloorplan: z.ZodBoolean;
+        pdfCount: z.ZodNumber;
+        hasTerrain: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersListArgs: z.ZodObject<{
+    storeyId: z.ZodString;
+    layerType: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        terrain: "terrain";
+        buildings: "buildings";
+        cad: "cad";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        rough: "rough";
+        image: "image";
+        pdf: "pdf";
+    }>>;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersListResult: z.ZodObject<{
+    layers: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        layerType: z.ZodEnum<{
+            default: "default";
+            terrain: "terrain";
+            buildings: "buildings";
+            cad: "cad";
+            floor: "floor";
+            wall: "wall";
+            ceiling: "ceiling";
+            rough: "rough";
+            image: "image";
+            pdf: "pdf";
+        }>;
+        storeyId: z.ZodString;
+        buildingId: z.ZodString;
+        hidden: z.ZodBoolean;
+        locked: z.ZodBoolean;
+        contentSummary: z.ZodObject<{
+            hasFloorplan: z.ZodBoolean;
+            pdfCount: z.ZodNumber;
+            hasTerrain: z.ZodBoolean;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersGetArgs: z.ZodObject<{
+    layerId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreStoreysLayersGetArgs = z.infer<typeof PluginCoreStoreysLayersGetArgs>;
+/**
+ * Result of {@linkcode PluginCoreStoreysLayersApi.get} — the layer, or `null`
+ * when no layer has the given id.
+ */
+export declare const PluginCoreStoreysLayersGetResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    layerType: z.ZodEnum<{
+        default: "default";
+        terrain: "terrain";
+        buildings: "buildings";
+        cad: "cad";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        rough: "rough";
+        image: "image";
+        pdf: "pdf";
+    }>;
+    storeyId: z.ZodString;
+    buildingId: z.ZodString;
+    hidden: z.ZodBoolean;
+    locked: z.ZodBoolean;
+    contentSummary: z.ZodObject<{
+        hasFloorplan: z.ZodBoolean;
+        pdfCount: z.ZodNumber;
+        hasTerrain: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>>;
+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 declare const PluginCoreStoreysLayersGetActiveArgs: z.ZodObject<{
+    storeyId: z.ZodString;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersGetActiveResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    layerType: z.ZodEnum<{
+        default: "default";
+        terrain: "terrain";
+        buildings: "buildings";
+        cad: "cad";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        rough: "rough";
+        image: "image";
+        pdf: "pdf";
+    }>;
+    storeyId: z.ZodString;
+    buildingId: z.ZodString;
+    hidden: z.ZodBoolean;
+    locked: z.ZodBoolean;
+    contentSummary: z.ZodObject<{
+        hasFloorplan: z.ZodBoolean;
+        pdfCount: z.ZodNumber;
+        hasTerrain: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>>;
+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 declare const PluginCoreStoreysLayersSetActiveArgs: z.ZodObject<{
+    layerId: z.ZodString;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersSetActiveResult: z.ZodObject<{
+    layerId: z.ZodString;
+}, z.core.$strip>;
+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 declare const PluginCoreStoreysLayersUpdateArgs: z.ZodObject<{
+    layerId: z.ZodString;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginCoreStoreysLayersUpdateArgs = z.infer<typeof PluginCoreStoreysLayersUpdateArgs>;
+/** Result of {@linkcode PluginCoreStoreysLayersApi.update} — the updated layer. */
+export declare const PluginCoreStoreysLayersUpdateResult: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    layerType: z.ZodEnum<{
+        default: "default";
+        terrain: "terrain";
+        buildings: "buildings";
+        cad: "cad";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        rough: "rough";
+        image: "image";
+        pdf: "pdf";
+    }>;
+    storeyId: z.ZodString;
+    buildingId: z.ZodString;
+    hidden: z.ZodBoolean;
+    locked: z.ZodBoolean;
+    contentSummary: z.ZodObject<{
+        hasFloorplan: z.ZodBoolean;
+        pdfCount: z.ZodNumber;
+        hasTerrain: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginCoreStoreysLayersUpdateResult = z.infer<typeof PluginCoreStoreysLayersUpdateResult>;
+//# sourceMappingURL=layers.d.ts.map

package/dist/api/core/storeys/layers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layers.d.ts","sourceRoot":"","sources":["../../../../src/api/core/storeys/layers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,IAAI,CAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,yBAAyB,GACpC,eAAe,CAAC,iCAAiC,CAAC;IAErD;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,QAAQ,EAAE,MAAM,GACf,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,OAAO,GACf,eAAe,CAAC,mCAAmC,CAAC;CACxD;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;EAWpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;iBAahC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;kBAAmC,CAAA;AAChF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;kBAAmC,CAAA;AACtF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,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,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,mFAAmF;AACnF,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;iBAAwB,CAAA;AACxE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA"}

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

@@ -145,6 +145,37 @@ export declare abstract class PluginCoreTagsApi {
      * ```
      */
     abstract listForComponent(componentId: ComponentHandle): PluginApiReturn<PluginCoreTagsGetTagsForComponentResult>;
+    /**
+     * List the tags carried by many components in one call.
+     *
+     * The plural of {@linkcode PluginCoreTagsApi.listForComponent}: pass
+     * `componentIds` to read specific components (unknown ids are skipped), or
+     * omit it to read **every** taggable component (Mass/Floor space) in the
+     * project. Each entry carries the component id and its tags — one per tagged
+     * category, with the tag's `color` — so a plugin can color every space by a
+     * chosen category's tag in a single round-trip.
+     *
+     * @param componentIds - Optional `Component.id`s to read; omit for all spaces.
+     * @returns A {@linkcode PluginCoreTagsListForComponentsResult} with a
+     *   `components` array, one entry per component (in input order when
+     *   `componentIds` is given).
+     *
+     * @performance One round-trip for any number of components — use this instead of a `listForComponent` loop.
+     *
+     * @examplePrompt Get the tags of every space with their colors
+     * @examplePrompt List the tags on all rooms so I can color them by Occupancy
+     * @examplePrompt Which tag does each selected space carry?
+     *
+     * # Example
+     * ```ts
+     * const { components } = await snaptrude.core.tags.listForComponents()
+     * for (const c of components) {
+     *   const occupancy = c.tags.find((t) => t.categoryName === "Occupancy")
+     *   if (occupancy) paint(c.componentId, occupancy.color)
+     * }
+     * ```
+     */
+    abstract listForComponents(componentIds?: ComponentHandle[]): PluginApiReturn<PluginCoreTagsListForComponentsResult>;
     /**
      * List the components carrying a given tag or category.
      *
@@ -427,8 +458,8 @@ export declare const PluginCoreAssignOutcome: z.ZodObject<{
         id: z.ZodString;
         reason: z.ZodEnum<{
             locked: "locked";
-            "not-taggable": "not-taggable";
             "not-found": "not-found";
+            "not-taggable": "not-taggable";
         }>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
@@ -546,6 +577,56 @@ export declare const PluginCoreTagsGetTagsForComponentResult: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type PluginCoreTagsGetTagsForComponentResult = z.infer<typeof PluginCoreTagsGetTagsForComponentResult>;
+/**
+ * Arguments for {@linkcode PluginCoreTagsApi.listForComponents}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentIds` | `ComponentHandle[]?` | Components to read; omit for every taggable component |
+ */
+export declare const PluginCoreTagsListForComponentsArgs: z.ZodObject<{
+    componentIds: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>>;
+}, z.core.$strip>;
+export type PluginCoreTagsListForComponentsArgs = z.infer<typeof PluginCoreTagsListForComponentsArgs>;
+/**
+ * One component's tags, for {@linkcode PluginCoreTagsApi.listForComponents}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentId` | `ComponentHandle` | The component's id |
+ * | `tags` | {@linkcode PluginCoreComponentTag}`[]` | Its tags, one per tagged category (empty when none) |
+ */
+export declare const PluginCoreComponentTags: z.ZodObject<{
+    componentId: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    tags: z.ZodArray<z.ZodObject<{
+        categoryId: z.ZodString;
+        categoryName: z.ZodString;
+        tagId: z.ZodString;
+        tagName: z.ZodString;
+        color: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCoreComponentTags = z.infer<typeof PluginCoreComponentTags>;
+/**
+ * Result of {@linkcode PluginCoreTagsApi.listForComponents}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode PluginCoreComponentTags}`[]` | One entry per component |
+ */
+export declare const PluginCoreTagsListForComponentsResult: z.ZodObject<{
+    components: z.ZodArray<z.ZodObject<{
+        componentId: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+        tags: z.ZodArray<z.ZodObject<{
+            categoryId: z.ZodString;
+            categoryName: z.ZodString;
+            tagId: z.ZodString;
+            tagName: z.ZodString;
+            color: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCoreTagsListForComponentsResult = z.infer<typeof PluginCoreTagsListForComponentsResult>;
 /**
  * Arguments for {@linkcode PluginCoreTagsApi.listComponents}. Provide exactly one
  * of `tagId`, `categoryId`. `untagged` is valid only with `categoryId`.
@@ -740,8 +821,8 @@ export declare const PluginCoreTagsAssignResult: z.ZodObject<{
         id: z.ZodString;
         reason: z.ZodEnum<{
             locked: "locked";
-            "not-taggable": "not-taggable";
             "not-found": "not-found";
+            "not-taggable": "not-taggable";
         }>;
     }, z.core.$strip>>;
     categoryId: z.ZodString;
@@ -770,8 +851,8 @@ export declare const PluginCoreTagsUnassignResult: z.ZodObject<{
         id: z.ZodString;
         reason: z.ZodEnum<{
             locked: "locked";
-            "not-taggable": "not-taggable";
             "not-found": "not-found";
+            "not-taggable": "not-taggable";
         }>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

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

@@ -1 +1 @@
-{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../../src/api/core/tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAAsB,iBAAiB;;IAGrC;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAErF;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;OAgBG;aACa,IAAI,CAClB,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,mBAAmB,CACjC,WAAW,EAAE,eAAe,GAC3B,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,gBAAgB,CAC9B,WAAW,EAAE,eAAe,GAC3B,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,cAAc,CAC5B,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAClE,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;OAiBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;OAkBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,MAAM,CACpB,YAAY,EAAE,eAAe,EAAE,EAC/B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,eAAe,EAAE,GAC9B,eAAe,CAAC,4BAA4B,CAAC;CACjD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa;;;;;iBAKxB,CAAA;AACF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;kBAAmC,CAAA;AAC/E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;kBAA2B,CAAA;AAC/D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;;iBAWzC,CAAA;AACJ,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,qFAAqF;AACrF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,oEAAoE;AACpE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,wEAAwE;AACxE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAKrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,+EAA+E;AAC/E,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAA0B,CAAA;AACnE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../../src/api/core/tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAAsB,iBAAiB;;IAGrC;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAErF;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;OAgBG;aACa,IAAI,CAClB,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,mBAAmB,CACjC,WAAW,EAAE,eAAe,GAC3B,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,gBAAgB,CAC9B,WAAW,EAAE,eAAe,GAC3B,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,iBAAiB,CAC/B,YAAY,CAAC,EAAE,eAAe,EAAE,GAC/B,eAAe,CAAC,qCAAqC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,cAAc,CAC5B,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAClE,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;OAiBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;OAkBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,MAAM,CACpB,YAAY,EAAE,eAAe,EAAE,EAC/B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,eAAe,EAAE,GAC9B,eAAe,CAAC,4BAA4B,CAAC;CACjD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa;;;;;iBAKxB,CAAA;AACF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;kBAAmC,CAAA;AAC/E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;kBAA2B,CAAA;AAC/D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,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,uBAAuB;;;;;;;;;iBAGlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;;iBAWzC,CAAA;AACJ,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,qFAAqF;AACrF,eAAO,MAAM,kCAAkC;;;;iBAAwB,CAAA;AACvE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,oEAAoE;AACpE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,wEAAwE;AACxE,eAAO,MAAM,0BAA0B;;;;;iBAAgB,CAAA;AACvD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAKrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,+EAA+E;AAC/E,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAA0B,CAAA;AACnE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}

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

@@ -4,12 +4,21 @@ import { PluginApiReturn } from "../../../types";
  *
  * Frame the viewport camera onto scene geometry — mirrors the canvas zoom menu
  * ("Zoom extents" / "Zoom to selection"). Accessed via `snaptrude.core.zoom`.
+ *
+ * While Present mode is open these calls set the Design frame a view saved in
+ * Present (`presentation.views.create`) is taken from; they never move the
+ * Present sheet canvas. To pan, zoom or screenshot the Present canvas, use
+ * {@linkcode PluginPresentationCameraApi} (`presentation.camera`).
  */
 export declare abstract class PluginZoomApi {
     constructor();
     /**
      * Zoom (fit) the camera to all geometry in the scene — the "zoom extents" action.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @returns `true` once the camera has been framed to the scene.
      *
      * @examplePrompt Zoom out so I can see the whole model
@@ -29,6 +38,10 @@ export declare abstract class PluginZoomApi {
     /**
      * Zoom (fit) the camera to the current selection.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @returns `true` if there was a selection to frame; `false` if nothing is
      *   selected (no-op).
      *

package/dist/api/core/zoom/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/zoom/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;GAKG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC;IAEnD;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,IAAI,eAAe,CAAC,OAAO,CAAC;CACtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/zoom/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;;;;;;GAUG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,SAAS,IAAI,eAAe,CAAC,OAAO,CAAC;CACtD"}