@snaptrude/plugin-core 0.2.4 → 0.2.5

package/dist/api/entity/space.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../src/api/entity/space.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAK7C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,iBAAiB,CAAC,EAChC,QAAQ,EACR,UAAU,GACX,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;aACa,iBAAiB,CAAC,EAChC,OAAO,EACP,aAAa,EACb,aAAa,EACb,QAAQ,GACT,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;aACa,yBAAyB,CAAC,EACxC,OAAO,EACP,OAAO,EACP,aAAa,GACd,EAAE,wCAAwC,GAAG,eAAe,CAAC,0CAA0C,CAAC;IAEzG;;;;;;;;;;;;;;OAcG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,GACX,EAAE,kBAAkB,GAAG,eAAe,CAAC,oBAAoB,CAAC;IAE7D;;;;;;;;;;;;;;;OAeG;aACa,MAAM,CAAC,EACrB,OAAO,GACR,EAAE,qBAAqB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,MAAM,CACpB,IAAI,EAAE,qBAAqB,GAC1B,eAAe,CAAC,uBAAuB,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;iBAO3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAInD,CAAA;AAEF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0CAA0C;;iBAErD,CAAA;AAEF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;EAyBjC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;EAW1B,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2BrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;iBAElC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,sFAAsF;AACtF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAA;AAE1C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;EAazB,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B;;;;;EAKtC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;eAG7B,CAAA;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAMlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA"}

package/dist/api/entity/story.d.ts

@@ -0,0 +1,239 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Story (floor/storey) management.
+ *
+ * A story represents a building floor in the Snaptrude project. Stories
+ * are identified by their integer **story value** (e.g. `1` for ground
+ * floor, `2` for first floor, `-1` for a basement).
+ *
+ * All methods are **host API calls** that return Promises and support
+ * undo/redo via Snaptrude's command system.
+ *
+ * Accessed via `snaptrude.entity.story`.
+ */
+export declare abstract class PluginStoryApi {
+    constructor();
+    /**
+     * Get properties of a story by its storey number.
+     *
+     * Only the properties listed in {@linkcode PluginStoryGetArgs.properties args.properties}
+     * are returned — unlisted properties will be `undefined` in the result.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginStoryGetArgs.storyValue args.storyValue} — Integer storey number
+     *     (e.g. `1` for ground floor, `2` for first floor, `-1` for basement)
+     *   - {@linkcode PluginStoryGetArgs.properties args.properties} — Array of property names
+     *     to retrieve. See {@linkcode PluginStoryGetProperty} for available values.
+     * @returns A partial {@linkcode PluginStoryGetResult} containing only the requested properties
+     * @throws If the story with the given value does not exist
+     *
+     * # Example
+     * ```ts
+     * const info = await snaptrude.entity.story.get({
+     *   storyValue: 1,
+     *   properties: ["height", "name", "spacesCount"],
+     * })
+     * console.log(info.name, info.height, info.spacesCount)
+     * ```
+     */
+    abstract get({ storyValue, properties, }: PluginStoryGetArgs): PluginApiReturn<PluginStoryGetResult>;
+    /**
+     * Get all stories in the current project.
+     *
+     * Returns basic identification data for every storey. Stories are sorted
+     * from **top to bottom** (highest story value first).
+     *
+     * @returns A {@linkcode PluginStoryGetAllResult} with a `stories` array,
+     *   each entry containing `value`, `id`, and `name`
+     *
+     * # Example
+     * ```ts
+     * const { stories } = await snaptrude.entity.story.getAll()
+     * for (const s of stories) {
+     *   console.log(`Story ${s.value}: ${s.name} (id: ${s.id})`)
+     * }
+     * ```
+     */
+    abstract getAll(): PluginApiReturn<PluginStoryGetAllResult>;
+    /**
+     * Create a new story (floor) in the project.
+     *
+     * The new story is inserted at the position specified by
+     * {@linkcode PluginStoryCreateArgs.storyValue args.storyValue}. This
+     * operation is undoable.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginStoryCreateArgs.storyValue args.storyValue} — Integer storey number
+     *     to create (e.g. `3` to add a third floor)
+     *   - {@linkcode PluginStoryCreateArgs.height args.height} — Optional height in Babylon
+     *     units. If omitted, the project's default storey height is used.
+     * @returns A {@linkcode PluginStoryCreateResult} with `storyId` and `storyValue`
+     * @throws If a story with the given value already exists or creation fails
+     *
+     * # Example
+     * ```ts
+     * // Create a new third floor with custom height
+     * const { storyId } = await snaptrude.entity.story.create({
+     *   storyValue: 3,
+     *   height: 4.5,
+     * })
+     * ```
+     */
+    abstract create({ storyValue, height, }: PluginStoryCreateArgs): PluginApiReturn<PluginStoryCreateResult>;
+    /**
+     * Update a story's height.
+     *
+     * Changes the floor-to-floor height of the specified story. This
+     * operation is undoable.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginStoryUpdateArgs.storyValue args.storyValue} — Integer storey number
+     *     identifying the story to update
+     *   - {@linkcode PluginStoryUpdateArgs.height args.height} — New height value in Babylon
+     *     units
+     * @returns A {@linkcode PluginStoryUpdateResult} with the updated `storyValue` and `height`
+     * @throws If the story does not exist or the update fails
+     *
+     * # Example
+     * ```ts
+     * // Set ground floor height to 5 Babylon units
+     * const result = await snaptrude.entity.story.update({
+     *   storyValue: 1,
+     *   height: 5,
+     * })
+     * ```
+     */
+    abstract update({ storyValue, height, }: PluginStoryUpdateArgs): PluginApiReturn<PluginStoryUpdateResult>;
+}
+/**
+ * Available properties that can be queried on a story.
+ *
+ * | Value | Type | Description |
+ * |---|---|---|
+ * | `"value"` | `number` | The integer storey number |
+ * | `"id"` | `string` | Unique story identifier |
+ * | `"name"` | `string` | Display name of the story |
+ * | `"height"` | `number` | Floor-to-floor height in Babylon units |
+ * | `"base"` | `number` | Base elevation in Babylon units |
+ * | `"hidden"` | `boolean` | Whether the story is hidden in the viewport |
+ * | `"spacesCount"` | `number` | Number of spaces on this story |
+ * | `"totalArea"` | `number` | Total floor area of this story |
+ */
+export declare const PluginStoryGetProperty: z.ZodEnum<{
+    value: "value";
+    name: "name";
+    id: "id";
+    height: "height";
+    base: "base";
+    hidden: "hidden";
+    spacesCount: "spacesCount";
+    totalArea: "totalArea";
+}>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` (int) | The storey number to query |
+ * | `properties` | {@linkcode PluginStoryGetProperty}`[]` | Properties to retrieve |
+ */
+export declare const PluginStoryGetArgs: z.ZodObject<{
+    storyValue: z.ZodNumber;
+    properties: z.ZodArray<z.ZodEnum<{
+        value: "value";
+        name: "name";
+        id: "id";
+        height: "height";
+        base: "base";
+        hidden: "hidden";
+        spacesCount: "spacesCount";
+        totalArea: "totalArea";
+    }>>;
+}, z.core.$strip>;
+export type PluginStoryGetArgs = z.infer<typeof PluginStoryGetArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.get}.
+ *
+ * A partial object — only the properties that were requested in
+ * {@linkcode PluginStoryGetArgs.properties} will be present.
+ */
+export declare const PluginStoryGetResult: z.ZodObject<{
+    value: z.ZodOptional<z.ZodNumber>;
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    height: z.ZodOptional<z.ZodNumber>;
+    base: z.ZodOptional<z.ZodNumber>;
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    spacesCount: z.ZodOptional<z.ZodNumber>;
+    totalArea: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginStoryGetResult = z.infer<typeof PluginStoryGetResult>;
+/**
+ * Result of {@linkcode PluginStoryApi.getAll}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `stories` | `Array<{ value, id, name }>` | All stories, sorted top to bottom |
+ */
+export declare const PluginStoryGetAllResult: z.ZodObject<{
+    stories: z.ZodArray<z.ZodObject<{
+        value: z.ZodNumber;
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginStoryGetAllResult = z.infer<typeof PluginStoryGetAllResult>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.create}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` (int) | The storey number for the new story |
+ * | `height` | `number?` | Optional height in Babylon units |
+ */
+export declare const PluginStoryCreateArgs: z.ZodObject<{
+    storyValue: z.ZodNumber;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginStoryCreateArgs = z.infer<typeof PluginStoryCreateArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.create}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyId` | `string` | Unique ID of the created story |
+ * | `storyValue` | `number` | The storey number of the created story |
+ */
+export declare const PluginStoryCreateResult: z.ZodObject<{
+    storyId: z.ZodString;
+    storyValue: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryCreateResult = z.infer<typeof PluginStoryCreateResult>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.update}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` (int) | Storey number of the story to update |
+ * | `height` | `number` | New height in Babylon units |
+ */
+export declare const PluginStoryUpdateArgs: z.ZodObject<{
+    storyValue: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryUpdateArgs = z.infer<typeof PluginStoryUpdateArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.update}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` | The storey number of the updated story |
+ * | `height` | `number` | The new height after the update |
+ */
+export declare const PluginStoryUpdateResult: z.ZodObject<{
+    storyValue: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryUpdateResult = z.infer<typeof PluginStoryUpdateResult>;
+//# sourceMappingURL=story.d.ts.map

package/dist/api/entity/story.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../../src/api/entity/story.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,GAAG,CAAC,EAClB,UAAU,EACV,UAAU,GACX,EAAE,kBAAkB,GAAG,eAAe,CAAC,oBAAoB,CAAC;IAE7D;;;;;;;;;;;;;;;;OAgBG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CAAC,EACrB,UAAU,EACV,MAAM,GACP,EAAE,qBAAqB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CAAC,EACrB,UAAU,EACV,MAAM,GACP,EAAE,qBAAqB,GAAG,eAAe,CAAC,uBAAuB,CAAC;CACpE;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EASjC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAWrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAQlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA"}

package/dist/api/index.d.ts

@@ -0,0 +1,30 @@
+import { PluginCoreApi } from "./core";
+import { PluginEntityApi } from "./entity";
+import { PluginToolsApi } from "./tools";
+import { PluginUnitsApi } from "./units";
+/**
+ * Root API surface for Snaptrude plugins.
+ *
+ * Access all plugin capabilities through the namespaced properties:
+ *
+ * - {@linkcode PluginApi.core} — Math and geometry primitives
+ * - {@linkcode PluginApi.entity} — CRUD operations on Snaptrude entities (spaces, stories)
+ * - {@linkcode PluginApi.tools} — Copy, offset, selection, and transform tools
+ * - {@linkcode PluginApi.units} — Unit conversion utilities
+ */
+export declare abstract class PluginApi {
+    /** Core math and geometry primitives. See {@linkcode PluginCoreApi}. */
+    abstract core: PluginCoreApi;
+    /** Copy, offset, selection, and transform tools. See {@linkcode PluginToolsApi}. */
+    abstract tools: PluginToolsApi;
+    /** CRUD operations on Snaptrude entities. See {@linkcode PluginEntityApi}. */
+    abstract entity: PluginEntityApi;
+    /** Unit conversion utilities. See {@linkcode PluginUnitsApi}. */
+    abstract units: PluginUnitsApi;
+    constructor();
+}
+export * from "./core";
+export * from "./entity";
+export * from "./tools";
+export * from "./units";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;;;;GASG;AACH,8BAAsB,SAAS;IAC7B,wEAAwE;IACxE,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,oFAAoF;IACpF,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,8EAA8E;IAC9E,SAAgB,MAAM,EAAE,eAAe,CAAA;IACvC,iEAAiE;IACjE,SAAgB,KAAK,EAAE,cAAc,CAAA;;CAGtC;AAED,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/dist/api/tools/copy.d.ts

@@ -0,0 +1,59 @@
+import * as z from "zod";
+import type { ComponentId } from "../../types";
+/**
+ * Copy mode for `snaptrude.tools.copy`.
+ *
+ * | Value | Description |
+ * |---|---|
+ * | `"instance"` | Create instanced copies where possible |
+ * | `"unique"` | Create independent geometry copies |
+ */
+export declare const PluginCopyMode: z.ZodEnum<{
+    instance: "instance";
+    unique: "unique";
+}>;
+export type PluginCopyMode = z.infer<typeof PluginCopyMode>;
+/**
+ * Arguments for `snaptrude.tools.copy`.
+ *
+ * Creates one or more copies for each component in `componentIds`. Copy `i` is
+ * offset by `displacement * i`, where `i` starts at `1`. Source positions are
+ * preserved. In `"instance"` mode, a unique source mesh can be replaced by an
+ * instance at the same position so the source and copied objects remain in the
+ * same instance family. The created copy stack becomes the active editor
+ * selection, matching the native paste workflow.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentIds` | `string[]` | Component IDs to copy |
+ * | `displacement` | {@linkcode PVec3} | Offset applied to each copy in Babylon units |
+ * | `count` | `number` | Number of copies per component. Defaults to `1` |
+ * | `copyMode` | {@linkcode PluginCopyMode} | `"instance"` or `"unique"`. Defaults to `"instance"` |
+ */
+export declare const PluginCopyArgs: z.ZodObject<{
+    componentIds: z.ZodArray<z.ZodString>;
+    displacement: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    count: z.ZodOptional<z.ZodNumber>;
+    copyMode: z.ZodOptional<z.ZodEnum<{
+        instance: "instance";
+        unique: "unique";
+    }>>;
+}, z.core.$strip>;
+export type PluginCopyArgs = z.infer<typeof PluginCopyArgs>;
+/**
+ * Result of `snaptrude.tools.copy`.
+ *
+ * Returned IDs are Snaptrude component IDs for the newly created copies, not
+ * Babylon mesh IDs.
+ */
+export declare const PluginCopyResult: z.ZodObject<{
+    copiedIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginCopyResult = {
+    copiedIds: ComponentId[];
+};
+//# sourceMappingURL=copy.d.ts.map

package/dist/api/tools/copy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy.d.ts","sourceRoot":"","sources":["../../../src/api/tools/copy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAG9C;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;;EAAiC,CAAA;AAE5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;iBAKzB,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;iBAE3B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,WAAW,EAAE,CAAA;CACzB,CAAA"}

package/dist/api/tools/index.d.ts

@@ -0,0 +1,29 @@
+import { PluginSelectionApi } from "./selection";
+import { PluginTransformApi } from "./transform";
+import type { PluginApiReturn } from "../../types";
+import type { PluginCopyArgs, PluginCopyResult } from "./copy";
+import type { PluginOffsetArgs, PluginOffsetResult } from "./offset";
+/**
+ * Snaptrude editor tools for querying and manipulating scene components.
+ *
+ * - {@linkcode PluginToolsApi.selection} — Query the current user selection
+ * - {@linkcode PluginToolsApi.transform} — Move and rotate components
+ * - {@linkcode PluginToolsApi.copy} — Copy components
+ * - {@linkcode PluginToolsApi.offset} — Offset or split component profiles
+ */
+export declare abstract class PluginToolsApi {
+    /** Query the current selection. See {@linkcode PluginSelectionApi}. */
+    abstract selection: PluginSelectionApi;
+    /** Move and rotate components. See {@linkcode PluginTransformApi}. */
+    abstract transform: PluginTransformApi;
+    /** Copy components by ID. See {@linkcode PluginCopyArgs}. */
+    abstract copy(args: PluginCopyArgs): PluginApiReturn<PluginCopyResult>;
+    /** Offset or split a component profile. See {@linkcode PluginOffsetArgs}. */
+    abstract offset(args: PluginOffsetArgs): PluginApiReturn<PluginOffsetResult>;
+    constructor();
+}
+export * from "./copy";
+export * from "./offset";
+export * from "./selection";
+export * from "./transform";
+//# sourceMappingURL=index.d.ts.map

package/dist/api/tools/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/tools/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAEpE;;;;;;;GAOG;AACH,8BAAsB,cAAc;IAClC,uEAAuE;IACvE,SAAgB,SAAS,EAAE,kBAAkB,CAAA;IAC7C,sEAAsE;IACtE,SAAgB,SAAS,EAAE,kBAAkB,CAAA;IAE7C,6DAA6D;aAC7C,IAAI,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe,CAAC,gBAAgB,CAAC;IAE7E,6EAA6E;aAC7D,MAAM,CACpB,IAAI,EAAE,gBAAgB,GACrB,eAAe,CAAC,kBAAkB,CAAC;;CAGvC;AAED,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}

package/dist/api/tools/offset.d.ts

@@ -0,0 +1,43 @@
+import * as z from "zod";
+import type { ComponentId } from "../../types";
+/**
+ * Arguments for `snaptrude.tools.offset`.
+ *
+ * Runs Snaptrude's offset/split operation on the top profile of a scene
+ * component. A positive distance offsets outward from the selected profile;
+ * a negative distance offsets inward. If `profilePickPoint` is omitted, the
+ * outer top profile is used. If `profilePickPoint` is provided, the nearest top
+ * contour profile to that point is used, matching the interactive offset tool's
+ * pick behavior.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentId` | `string` | Component ID to offset |
+ * | `distance` | `number` | Signed offset distance in Snaptrude units |
+ * | `profilePickPoint` | {@linkcode PVec3} | Optional point used to choose a top contour profile |
+ */
+export declare const PluginOffsetArgs: z.ZodObject<{
+    componentId: z.ZodString;
+    distance: z.ZodNumber;
+    profilePickPoint: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginOffsetArgs = z.infer<typeof PluginOffsetArgs>;
+/**
+ * Result of `snaptrude.tools.offset`.
+ *
+ * `createdIds` are the components created by the offset operation. `deletedIds`
+ * are components removed by split-style offsets.
+ */
+export declare const PluginOffsetResult: z.ZodObject<{
+    createdIds: z.ZodArray<z.ZodString>;
+    deletedIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginOffsetResult = {
+    createdIds: ComponentId[];
+    deletedIds: ComponentId[];
+};
+//# sourceMappingURL=offset.d.ts.map

package/dist/api/tools/offset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"offset.d.ts","sourceRoot":"","sources":["../../../src/api/tools/offset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAG9C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;iBAI3B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,WAAW,EAAE,CAAA;IACzB,UAAU,EAAE,WAAW,EAAE,CAAA;CAC1B,CAAA"}

package/dist/api/tools/selection.d.ts

@@ -0,0 +1,48 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Query the current user selection in the Snaptrude editor.
+ *
+ * Accessed via `snaptrude.tools.selection`.
+ */
+export declare abstract class PluginSelectionApi {
+    constructor();
+    /**
+     * Get the IDs of all currently selected components.
+     *
+     * Returns the component IDs from the editor's active selection stack.
+     * If nothing is selected, returns an empty array.
+     *
+     * The returned IDs can be used with {@linkcode PluginTransformApi.move},
+     * {@linkcode PluginTransformApi.rotate}, or entity query methods like
+     * {@linkcode PluginSpaceApi.get}.
+     *
+     * @returns A {@linkcode PluginSelectionGetResult} with a `selected` array
+     *   of component ID strings
+     *
+     * # Example
+     * ```ts
+     * const { selected } = await snaptrude.tools.selection.get()
+     * if (selected.length > 0) {
+     *   // Move selected components 5 units along X
+     *   await snaptrude.tools.transform.move({
+     *     componentIds: selected,
+     *     displacement: snaptrude.core.math.vec3.new(5, 0, 0),
+     *   })
+     * }
+     * ```
+     */
+    abstract get(): PluginApiReturn<PluginSelectionGetResult>;
+}
+/**
+ * Result of {@linkcode PluginSelectionApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `selected` | `string[]` | Component IDs of the current selection |
+ */
+export declare const PluginSelectionGetResult: z.ZodObject<{
+    selected: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginSelectionGetResult = z.infer<typeof PluginSelectionGetResult>;
+//# sourceMappingURL=selection.d.ts.map

package/dist/api/tools/selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection.d.ts","sourceRoot":"","sources":["../../../src/api/tools/selection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;GAIG;AACH,8BAAsB,kBAAkB;;IAGtC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,IAAI,eAAe,CAAC,wBAAwB,CAAC;CACjE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}

package/dist/api/tools/transform.d.ts

@@ -0,0 +1,114 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Transform operations — move and rotate scene components.
+ *
+ * All transform methods accept an array of component IDs and apply the
+ * transformation to each. Operations are recorded in Snaptrude's
+ * command system for undo/redo support.
+ *
+ * Accessed via `snaptrude.tools.transform`.
+ */
+export declare abstract class PluginTransformApi {
+    constructor();
+    /**
+     * Translate components by a displacement vector.
+     *
+     * Each component's position is offset by the given
+     * {@linkcode PluginMoveArgs.displacement displacement} vector.
+     * This operation is undoable.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginMoveArgs.componentIds args.componentIds} — Array of component
+     *     ID strings to move
+     *   - {@linkcode PluginMoveArgs.displacement args.displacement} — Translation vector
+     *     as a {@linkcode PVec3} in Babylon units
+     * @throws If any component ID is not found in the scene
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * // Move a space 10 units along the X axis
+     * await snaptrude.tools.transform.move({
+     *   componentIds: ["some-space-id"],
+     *   displacement: vec3.new(10, 0, 0),
+     * })
+     * ```
+     */
+    abstract move({ componentIds, displacement, }: PluginMoveArgs): PluginApiReturn<void>;
+    /**
+     * Rotate components around an axis through a pivot point.
+     *
+     * Each component is rotated by {@linkcode PluginRotateArgs.angle angle}
+     * radians around the {@linkcode PluginRotateArgs.axis axis} vector,
+     * pivoting about the {@linkcode PluginRotateArgs.pivot pivot} point.
+     * This operation is undoable.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginRotateArgs.componentIds args.componentIds} — Array of component
+     *     ID strings to rotate
+     *   - {@linkcode PluginRotateArgs.angle args.angle} — Rotation angle in **radians**
+     *   - {@linkcode PluginRotateArgs.axis args.axis} — Rotation axis as a {@linkcode PVec3}
+     *   - {@linkcode PluginRotateArgs.pivot args.pivot} — Pivot point as a {@linkcode PVec3}
+     *     in Babylon units
+     * @throws If any component ID is not found in the scene
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * // Rotate a space 45° around the Y axis at the origin
+     * await snaptrude.tools.transform.rotate({
+     *   componentIds: ["some-space-id"],
+     *   angle: Math.PI / 4,
+     *   axis: vec3.new(0, 1, 0),
+     *   pivot: vec3.new(0, 0, 0),
+     * })
+     * ```
+     */
+    abstract rotate({ componentIds, angle, axis, pivot, }: PluginRotateArgs): PluginApiReturn<void>;
+}
+/**
+ * Arguments for {@linkcode PluginTransformApi.move}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentIds` | `string[]` | Component IDs to move |
+ * | `displacement` | {@linkcode PVec3} | Translation vector in Babylon units |
+ */
+export declare const PluginMoveArgs: z.ZodObject<{
+    componentIds: z.ZodArray<z.ZodString>;
+    displacement: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginMoveArgs = z.infer<typeof PluginMoveArgs>;
+/**
+ * Arguments for {@linkcode PluginTransformApi.rotate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentIds` | `string[]` | Component IDs to rotate |
+ * | `angle` | `number` | Rotation angle in radians |
+ * | `axis` | {@linkcode PVec3} | Rotation axis direction |
+ * | `pivot` | {@linkcode PVec3} | Pivot point in Babylon units |
+ */
+export declare const PluginRotateArgs: z.ZodObject<{
+    componentIds: z.ZodArray<z.ZodString>;
+    angle: z.ZodNumber;
+    axis: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    pivot: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginRotateArgs = z.infer<typeof PluginRotateArgs>;
+//# sourceMappingURL=transform.d.ts.map

package/dist/api/tools/transform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../src/api/tools/transform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C;;;;;;;;GAQG;AACH,8BAAsB,kBAAkB;;IAGtC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,IAAI,CAAC,EACnB,YAAY,EACZ,YAAY,GACb,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,MAAM,CAAC,EACrB,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,KAAK,GACN,EAAE,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;;;;;;iBAGzB,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;iBAK3B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}