@snaptrude/plugin-core 0.0.0-dev-20260708130115 → 0.0.0-dev-20260827135706
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +152 -1
- package/api-manifest.json +3620 -276
- package/dist/api/analysis/daylight.d.ts +603 -0
- package/dist/api/analysis/daylight.d.ts.map +1 -0
- package/dist/api/analysis/heatmaps.d.ts +658 -0
- package/dist/api/analysis/heatmaps.d.ts.map +1 -0
- package/dist/api/analysis/illuminance.d.ts +145 -0
- package/dist/api/analysis/illuminance.d.ts.map +1 -0
- package/dist/api/analysis/index.d.ts +59 -0
- package/dist/api/analysis/index.d.ts.map +1 -0
- package/dist/api/analysis/shadows.d.ts +165 -0
- package/dist/api/analysis/shadows.d.ts.map +1 -0
- package/dist/api/analysis/solar.d.ts +249 -0
- package/dist/api/analysis/solar.d.ts.map +1 -0
- package/dist/api/analysis/sunlightHours.d.ts +208 -0
- package/dist/api/analysis/sunlightHours.d.ts.map +1 -0
- package/dist/api/analysis/sunpath.d.ts +80 -0
- package/dist/api/analysis/sunpath.d.ts.map +1 -0
- package/dist/api/analysis/weather.d.ts +193 -0
- package/dist/api/analysis/weather.d.ts.map +1 -0
- package/dist/api/core/camera/index.d.ts +261 -0
- package/dist/api/core/camera/index.d.ts.map +1 -0
- package/dist/api/core/comment/index.d.ts +105 -2
- package/dist/api/core/comment/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +840 -14
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/delete/index.d.ts +8 -2
- package/dist/api/core/geom/delete/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/arc.d.ts +5 -5
- package/dist/api/core/geom/query/brep.d.ts +130 -18
- package/dist/api/core/geom/query/brep.d.ts.map +1 -1
- package/dist/api/core/geom/query/circle.d.ts +18 -18
- package/dist/api/core/geom/query/contour.d.ts +20 -20
- package/dist/api/core/geom/query/curve.d.ts +49 -49
- package/dist/api/core/geom/query/edge.d.ts +5 -5
- package/dist/api/core/geom/query/face.d.ts +16 -16
- package/dist/api/core/geom/query/halfedge.d.ts +8 -8
- package/dist/api/core/geom/query/profile.d.ts +19 -19
- package/dist/api/core/geom/query/vertex.d.ts +8 -8
- package/dist/api/core/geom/update/contour.d.ts +14 -14
- package/dist/api/core/geom/update/curve.d.ts +7 -7
- package/dist/api/core/geom/update/profile.d.ts +16 -16
- package/dist/api/core/handles/index.d.ts +210 -0
- package/dist/api/core/handles/index.d.ts.map +1 -0
- package/dist/api/core/index.d.ts +34 -0
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/io/export/index.d.ts +134 -0
- package/dist/api/core/io/export/index.d.ts.map +1 -0
- package/dist/api/core/io/import/index.d.ts +453 -0
- package/dist/api/core/io/import/index.d.ts.map +1 -0
- package/dist/api/core/io/index.d.ts +40 -0
- package/dist/api/core/io/index.d.ts.map +1 -0
- package/dist/api/core/io/job/index.d.ts +139 -0
- package/dist/api/core/io/job/index.d.ts.map +1 -0
- package/dist/api/core/io/query/index.d.ts +74 -0
- package/dist/api/core/io/query/index.d.ts.map +1 -0
- package/dist/api/core/io/terrain/index.d.ts +341 -0
- package/dist/api/core/io/terrain/index.d.ts.map +1 -0
- package/dist/api/core/io/underlay/index.d.ts +805 -0
- package/dist/api/core/io/underlay/index.d.ts.map +1 -0
- package/dist/api/core/layers.d.ts +7 -7
- package/dist/api/core/mode/index.d.ts +99 -0
- package/dist/api/core/mode/index.d.ts.map +1 -0
- package/dist/api/core/project/index.d.ts +68 -1
- package/dist/api/core/project/index.d.ts.map +1 -1
- package/dist/api/core/proposals/index.d.ts +531 -0
- package/dist/api/core/proposals/index.d.ts.map +1 -0
- package/dist/api/core/storeys/index.d.ts +265 -0
- package/dist/api/core/storeys/index.d.ts.map +1 -0
- package/dist/api/core/tags.d.ts +24 -0
- package/dist/api/core/tags.d.ts.map +1 -1
- package/dist/api/core/user.d.ts +44 -0
- package/dist/api/core/user.d.ts.map +1 -0
- package/dist/api/core/zoom/index.d.ts +4 -0
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/boolean/index.d.ts +4 -4
- package/dist/api/design/create/index.d.ts +568 -45
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/delete/index.d.ts +3 -0
- package/dist/api/design/delete/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +195 -0
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/edit/index.d.ts +1 -1
- package/dist/api/design/erase/index.d.ts +2 -2
- package/dist/api/design/family.d.ts +349 -0
- package/dist/api/design/family.d.ts.map +1 -0
- package/dist/api/design/furniture/index.d.ts +181 -8
- package/dist/api/design/furniture/index.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +98 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/lock.d.ts +26 -0
- package/dist/api/design/lock.d.ts.map +1 -1
- package/dist/api/design/materials/index.d.ts +270 -16
- package/dist/api/design/materials/index.d.ts.map +1 -1
- package/dist/api/design/query/geometry/index.d.ts +112 -0
- package/dist/api/design/query/geometry/index.d.ts.map +1 -1
- package/dist/api/design/query/index.d.ts +282 -11
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/query/referenceLines.d.ts +45 -0
- package/dist/api/design/query/referenceLines.d.ts.map +1 -0
- package/dist/api/design/query/spaces.d.ts +181 -8
- package/dist/api/design/query/spaces.d.ts.map +1 -1
- package/dist/api/design/selection/index.d.ts +144 -0
- package/dist/api/design/selection/index.d.ts.map +1 -1
- package/dist/api/design/transform/index.d.ts +172 -10
- package/dist/api/design/transform/index.d.ts.map +1 -1
- package/dist/api/design/types/index.d.ts +181 -0
- package/dist/api/design/types/index.d.ts.map +1 -0
- package/dist/api/design/update/index.d.ts +553 -2
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/visibility.d.ts +126 -0
- package/dist/api/design/visibility.d.ts.map +1 -0
- package/dist/api/design/windows/index.d.ts +113 -2
- package/dist/api/design/windows/index.d.ts.map +1 -1
- package/dist/api/entity/buildableEnvelope.d.ts +4 -0
- package/dist/api/entity/buildableEnvelope.d.ts.map +1 -1
- package/dist/api/entity/referenceLine.d.ts +10 -2
- package/dist/api/entity/referenceLine.d.ts.map +1 -1
- package/dist/api/entity/space.d.ts +21 -21
- package/dist/api/entity/story.d.ts +242 -15
- package/dist/api/entity/story.d.ts.map +1 -1
- package/dist/api/index.d.ts +10 -0
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/presentation/aiInspiration.d.ts +25 -25
- package/dist/api/presentation/annotate.d.ts +467 -0
- package/dist/api/presentation/annotate.d.ts.map +1 -0
- package/dist/api/presentation/diagrams.d.ts +111 -8
- package/dist/api/presentation/diagrams.d.ts.map +1 -1
- package/dist/api/presentation/export.d.ts +108 -0
- package/dist/api/presentation/export.d.ts.map +1 -0
- package/dist/api/presentation/import.d.ts +55 -4
- package/dist/api/presentation/import.d.ts.map +1 -1
- package/dist/api/presentation/index.d.ts +58 -1
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +1139 -0
- package/dist/api/presentation/placedViews.d.ts.map +1 -0
- package/dist/api/presentation/shapes.d.ts +481 -0
- package/dist/api/presentation/shapes.d.ts.map +1 -0
- package/dist/api/presentation/sheets.d.ts +452 -13
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/slideshow.d.ts +125 -0
- package/dist/api/presentation/slideshow.d.ts.map +1 -0
- package/dist/api/presentation/tables.d.ts +81 -0
- package/dist/api/presentation/tables.d.ts.map +1 -0
- package/dist/api/presentation/views.d.ts +367 -7
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/program/areas.d.ts +102 -12
- package/dist/api/program/areas.d.ts.map +1 -1
- package/dist/api/program/cores.d.ts +3 -99
- package/dist/api/program/cores.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +7 -15
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/layout.d.ts +346 -11
- package/dist/api/program/layout.d.ts.map +1 -1
- package/dist/api/program/site.d.ts +469 -13
- package/dist/api/program/site.d.ts.map +1 -1
- package/dist/api/program/spreadsheet.d.ts +365 -41
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/api/workspace/index.d.ts +505 -0
- package/dist/api/workspace/index.d.ts.map +1 -0
- package/dist/errors/codes.d.ts +34 -0
- package/dist/errors/codes.d.ts.map +1 -0
- package/dist/errors/envelope.d.ts +56 -0
- package/dist/errors/envelope.d.ts.map +1 -0
- package/dist/errors/index.d.ts +6 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/plugin-error.d.ts +69 -0
- package/dist/errors/plugin-error.d.ts.map +1 -0
- package/dist/handles.d.ts +97 -25
- package/dist/handles.d.ts.map +1 -1
- package/dist/host-utils.d.ts +4 -0
- package/dist/host-utils.d.ts.map +1 -1
- package/dist/index.cjs +4582 -1422
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4171 -1411
- package/dist/index.js.map +1 -1
- package/package.json +4 -2
- package/scripts/generate-manifest.mjs +45 -0
- package/scripts/generate-manifest.test.mjs +103 -4
- package/src/api/analysis/daylight.ts +470 -0
- package/src/api/analysis/heatmaps.ts +683 -0
- package/src/api/analysis/illuminance.ts +155 -0
- package/src/api/analysis/index.ts +61 -0
- package/src/api/analysis/shadows.ts +183 -0
- package/src/api/analysis/solar.ts +237 -0
- package/src/api/analysis/sunlightHours.ts +211 -0
- package/src/api/analysis/sunpath.ts +83 -0
- package/src/api/analysis/weather.ts +179 -0
- package/src/api/core/camera/index.ts +268 -0
- package/src/api/core/comment/index.ts +120 -2
- package/src/api/core/geom/create/index.ts +912 -1
- package/src/api/core/geom/delete/index.ts +6 -0
- package/src/api/core/geom/query/brep.ts +119 -0
- package/src/api/core/handles/index.ts +233 -0
- package/src/api/core/index.ts +34 -0
- package/src/api/core/io/export/index.ts +126 -0
- package/src/api/core/io/import/index.ts +496 -0
- package/src/api/core/io/index.ts +42 -0
- package/src/api/core/io/job/index.ts +140 -0
- package/src/api/core/io/query/index.ts +71 -0
- package/src/api/core/io/terrain/index.ts +360 -0
- package/src/api/core/io/underlay/index.ts +705 -0
- package/src/api/core/mode/index.ts +96 -0
- package/src/api/core/project/index.ts +62 -1
- package/src/api/core/proposals/index.ts +569 -0
- package/src/api/core/storeys/index.ts +294 -0
- package/src/api/core/tags.ts +27 -0
- package/src/api/core/user.ts +46 -0
- package/src/api/core/zoom/index.ts +4 -0
- package/src/api/design/create/index.ts +670 -30
- package/src/api/design/delete/index.ts +3 -0
- package/src/api/design/doors/index.ts +208 -0
- package/src/api/design/erase/index.ts +1 -1
- package/src/api/design/family.ts +388 -0
- package/src/api/design/furniture/index.ts +197 -8
- package/src/api/design/index.ts +102 -0
- package/src/api/design/lock.ts +27 -0
- package/src/api/design/materials/index.ts +334 -27
- package/src/api/design/query/geometry/index.ts +125 -3
- package/src/api/design/query/index.ts +217 -7
- package/src/api/design/query/referenceLines.ts +52 -0
- package/src/api/design/query/spaces.ts +143 -0
- package/src/api/design/selection/index.ts +129 -0
- package/src/api/design/transform/index.ts +170 -9
- package/src/api/design/types/index.ts +156 -0
- package/src/api/design/update/index.ts +631 -3
- package/src/api/design/visibility.ts +143 -0
- package/src/api/design/windows/index.ts +128 -2
- package/src/api/entity/buildableEnvelope.ts +4 -0
- package/src/api/entity/referenceLine.ts +8 -0
- package/src/api/entity/story.ts +259 -15
- package/src/api/index.ts +10 -0
- package/src/api/presentation/annotate.ts +385 -0
- package/src/api/presentation/diagrams.ts +118 -8
- package/src/api/presentation/export.ts +108 -0
- package/src/api/presentation/import.ts +51 -4
- package/src/api/presentation/index.ts +66 -1
- package/src/api/presentation/placedViews.ts +1120 -0
- package/src/api/presentation/shapes.ts +274 -0
- package/src/api/presentation/sheets.ts +400 -13
- package/src/api/presentation/slideshow.ts +134 -0
- package/src/api/presentation/tables.ts +84 -0
- package/src/api/presentation/views.ts +376 -8
- package/src/api/program/areas.ts +88 -15
- package/src/api/program/cores.ts +3 -91
- package/src/api/program/index.ts +7 -15
- package/src/api/program/layout.ts +365 -11
- package/src/api/program/site.ts +435 -13
- package/src/api/program/spreadsheet.ts +376 -35
- package/src/api/workspace/index.ts +563 -0
- package/src/errors/codes.ts +136 -0
- package/src/errors/envelope.ts +75 -0
- package/src/errors/index.ts +21 -0
- package/src/errors/plugin-error.ts +134 -0
- package/src/handles.ts +123 -13
- package/src/host-utils.ts +4 -0
- package/src/index.ts +1 -0
- package/test/errors.test.mjs +184 -0
- package/tsconfig.json +7 -2
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../../types";
|
|
3
|
+
import { ComponentHandle } from "../../../handles";
|
|
4
|
+
import { PluginStoryGetProperty, PluginStoryGetResult, PluginStoryCreateResult, PluginStoryUpdateResult, PluginStorySetActiveResult, PluginStoryDeleteResult, PluginStoryDuplicateResult } from "../../entity/story";
|
|
5
|
+
/**
|
|
6
|
+
* Storey (floor) management.
|
|
7
|
+
*
|
|
8
|
+
* A storey represents a building floor in the Snaptrude project. Storeys are
|
|
9
|
+
* identified by their integer **storey value** (e.g. `1` for the ground floor,
|
|
10
|
+
* `2` for the first floor, `-1` for a basement).
|
|
11
|
+
*
|
|
12
|
+
* This is the canonical home for storey operations; it shares its implementation
|
|
13
|
+
* and schemas with the deprecated `entity.story` surface. All methods are **host
|
|
14
|
+
* API calls** that return Promises and support undo/redo via Snaptrude's command
|
|
15
|
+
* system (except {@linkcode PluginCoreStoreysApi.setActive}, a view change).
|
|
16
|
+
*
|
|
17
|
+
* Accessed via `snaptrude.core.storeys`.
|
|
18
|
+
*/
|
|
19
|
+
export declare abstract class PluginCoreStoreysApi {
|
|
20
|
+
constructor();
|
|
21
|
+
/**
|
|
22
|
+
* Get properties of a storey by its storey number.
|
|
23
|
+
*
|
|
24
|
+
* Only the properties listed in `properties` are returned — unlisted
|
|
25
|
+
* properties will be `undefined` in the result.
|
|
26
|
+
*
|
|
27
|
+
* @param storyValue - Integer storey number
|
|
28
|
+
* (e.g. `1` for ground floor, `2` for first floor, `-1` for basement)
|
|
29
|
+
* @param properties - Array of property names to retrieve. See
|
|
30
|
+
* {@linkcode PluginStoryGetProperty} for available values.
|
|
31
|
+
* @returns A partial {@linkcode PluginStoryGetResult} containing only the requested properties
|
|
32
|
+
* @throws If the storey with the given value does not exist
|
|
33
|
+
*
|
|
34
|
+
* @examplePrompt What is the height of the ground floor?
|
|
35
|
+
* @examplePrompt How many rooms are on the second storey?
|
|
36
|
+
* @examplePrompt Get the total floor area of level 3
|
|
37
|
+
* @examplePrompt Is the first floor hidden in the viewport?
|
|
38
|
+
* @examplePrompt Show me the name and height of storey 2
|
|
39
|
+
*
|
|
40
|
+
* # Example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const info = await snaptrude.core.storeys.get(1, ["height", "name", "spacesCount"])
|
|
43
|
+
* console.log(info.name, info.height, info.spacesCount)
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
abstract get(storyValue: number, properties: PluginStoryGetProperty[]): PluginApiReturn<PluginStoryGetResult>;
|
|
47
|
+
/**
|
|
48
|
+
* List all storeys in the current project.
|
|
49
|
+
*
|
|
50
|
+
* Returns basic identification data for every storey. Storeys are sorted
|
|
51
|
+
* from **top to bottom** (highest storey value first).
|
|
52
|
+
*
|
|
53
|
+
* @returns A {@linkcode PluginCoreStoreysListResult} with a `storeys` array,
|
|
54
|
+
* each entry containing `value`, `id`, and `name`
|
|
55
|
+
*
|
|
56
|
+
* @examplePrompt How many floors does this building have?
|
|
57
|
+
* @examplePrompt List all the storeys in the project
|
|
58
|
+
* @examplePrompt Show me every level with its name
|
|
59
|
+
* @examplePrompt Which storeys exist in this model?
|
|
60
|
+
*
|
|
61
|
+
* # Example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const { storeys } = await snaptrude.core.storeys.list()
|
|
64
|
+
* for (const s of storeys) {
|
|
65
|
+
* console.log(`Storey ${s.value}: ${s.name} (id: ${s.id})`)
|
|
66
|
+
* }
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
abstract list(): PluginApiReturn<PluginCoreStoreysListResult>;
|
|
70
|
+
/**
|
|
71
|
+
* Create a new storey (floor) in the project.
|
|
72
|
+
*
|
|
73
|
+
* The new storey is inserted at the position specified by `storyValue`. This
|
|
74
|
+
* operation is undoable.
|
|
75
|
+
*
|
|
76
|
+
* @param storyValue - Integer storey number
|
|
77
|
+
* to create (e.g. `3` to add a third floor)
|
|
78
|
+
* @param height - Optional height in Babylon
|
|
79
|
+
* units. If omitted, the project's default storey height is used.
|
|
80
|
+
* @returns A {@linkcode PluginStoryCreateResult} with `storyId` and `storyValue`
|
|
81
|
+
* @throws If a storey with the given value already exists or creation fails
|
|
82
|
+
*
|
|
83
|
+
* @examplePrompt Add a third floor to the building
|
|
84
|
+
* @examplePrompt Create a new storey above the second floor
|
|
85
|
+
* @examplePrompt Add a basement level to this project
|
|
86
|
+
* @examplePrompt Insert a new level with a custom floor height
|
|
87
|
+
*
|
|
88
|
+
* # Example
|
|
89
|
+
* ```ts
|
|
90
|
+
* // Create a new third floor with custom height
|
|
91
|
+
* const { storyId } = await snaptrude.core.storeys.create(3, 4.5)
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
abstract create(storyValue: number, height?: number): PluginApiReturn<PluginStoryCreateResult>;
|
|
95
|
+
/**
|
|
96
|
+
* Update a storey's floor-to-floor `height` and/or `name`.
|
|
97
|
+
*
|
|
98
|
+
* **Height** is the same operation as editing the height in the Storeys panel:
|
|
99
|
+
* the walls, columns, and masses on the storey are **stretched** to the new
|
|
100
|
+
* height, every storey **above shifts up/down** by the delta so the stack stays
|
|
101
|
+
* contiguous, and coupled elements (staircases, parametric curtain walls,
|
|
102
|
+
* furniture offsets) are re-fitted. The whole height cascade is committed as
|
|
103
|
+
* **one undo step**. Height-locked elements are left untouched.
|
|
104
|
+
*
|
|
105
|
+
* **Name** is the same as renaming the storey in the Storeys panel: it is
|
|
106
|
+
* persisted immediately but, mirroring the panel, is **not** part of the height
|
|
107
|
+
* undo step.
|
|
108
|
+
*
|
|
109
|
+
* At least one of `height` or `options.name` must be supplied. Omitting the
|
|
110
|
+
* `height` argument (e.g. for a rename-only update) leaves the height untouched.
|
|
111
|
+
*
|
|
112
|
+
* @param storyValue - Integer storey number identifying the storey to update
|
|
113
|
+
* @param height - New floor-to-floor height in
|
|
114
|
+
* Babylon units. Omit to leave the height unchanged.
|
|
115
|
+
* @param options - `name` (new display name for the storey)
|
|
116
|
+
* @returns A {@linkcode PluginStoryUpdateResult} with the storey's
|
|
117
|
+
* `storyValue`, `height`, and `name` after the update
|
|
118
|
+
* @throws `PRECONDITION_FAILED` if no storey has the given value;
|
|
119
|
+
* `VALIDATION` if neither `height` nor `options.name` is supplied;
|
|
120
|
+
* `STORY_HEIGHT_REJECTED` if the engine rejects the height;
|
|
121
|
+
* `STORY_UPDATE_FAILED` if the storey cannot be re-read after the update
|
|
122
|
+
*
|
|
123
|
+
* @examplePrompt Change the ground floor height to 3.5 metres
|
|
124
|
+
* @examplePrompt Make the second storey taller
|
|
125
|
+
* @examplePrompt Rename the ground floor to "Lobby"
|
|
126
|
+
* @examplePrompt Set the floor-to-floor height of level 1
|
|
127
|
+
*
|
|
128
|
+
* # Example
|
|
129
|
+
* ```ts
|
|
130
|
+
* // Set ground floor height to 5 Babylon units — walls stretch and the
|
|
131
|
+
* // floors above move up to match, all in a single undo step.
|
|
132
|
+
* const result = await snaptrude.core.storeys.update(1, 5)
|
|
133
|
+
* // Rename only, leaving the height untouched.
|
|
134
|
+
* await snaptrude.core.storeys.update(1, undefined, { name: "Lobby" })
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
abstract update(storyValue: number, height?: number, options?: {
|
|
138
|
+
name?: string;
|
|
139
|
+
}): PluginApiReturn<PluginStoryUpdateResult>;
|
|
140
|
+
/**
|
|
141
|
+
* Get the active storey's value. Paired with {@linkcode PluginCoreStoreysApi.setActive}.
|
|
142
|
+
*
|
|
143
|
+
* @returns The active storey value, in the same numbering `list` and `get` use.
|
|
144
|
+
*
|
|
145
|
+
* @examplePrompt Which storey am I on?
|
|
146
|
+
* @examplePrompt What is the current storey?
|
|
147
|
+
*
|
|
148
|
+
* # Example
|
|
149
|
+
* ```ts
|
|
150
|
+
* const storey = await snaptrude.core.storeys.getActive()
|
|
151
|
+
* ```
|
|
152
|
+
*/
|
|
153
|
+
abstract getActive(): PluginApiReturn<number>;
|
|
154
|
+
/**
|
|
155
|
+
* Make a storey the active storey — the same as clicking it in the storey/layer
|
|
156
|
+
* panel. Subsequent draws and creates target this storey, and in 2D the
|
|
157
|
+
* viewport switches to it. This is a view/navigation change: it is **not**
|
|
158
|
+
* undoable and commits nothing to the model.
|
|
159
|
+
*
|
|
160
|
+
* @param storyValue - Integer storey number to activate
|
|
161
|
+
* @returns A {@linkcode PluginStorySetActiveResult} echoing the now-active `storyValue`
|
|
162
|
+
* @throws `PRECONDITION_FAILED` if no storey has the given value
|
|
163
|
+
*
|
|
164
|
+
* @examplePrompt Switch to the second floor
|
|
165
|
+
* @examplePrompt Make the ground storey active
|
|
166
|
+
* @examplePrompt Go to the basement level
|
|
167
|
+
* @examplePrompt Set level 3 as the current storey
|
|
168
|
+
*
|
|
169
|
+
* # Example
|
|
170
|
+
* ```ts
|
|
171
|
+
* // Activate storey 2, then draw a wall — it lands on storey 2.
|
|
172
|
+
* await snaptrude.core.storeys.setActive(2)
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
abstract setActive(storyValue: number): PluginApiReturn<PluginStorySetActiveResult>;
|
|
176
|
+
/**
|
|
177
|
+
* Delete a storey and everything on it — the same as removing it from the
|
|
178
|
+
* storey panel. Every element placed on the storey (walls, floors, masses, …)
|
|
179
|
+
* is deleted with it, the remaining storeys are re-stacked, and the active
|
|
180
|
+
* storey falls back to an adjacent one. Committed as a single undo step.
|
|
181
|
+
*
|
|
182
|
+
* @param storyValue - Integer storey number to delete
|
|
183
|
+
* @returns A {@linkcode PluginStoryDeleteResult} with the deleted `storyValue`
|
|
184
|
+
* and the `newActiveStory` the editor fell back to
|
|
185
|
+
* @throws `PRECONDITION_FAILED` if no storey has the given value; or if plugin
|
|
186
|
+
* writes are disabled
|
|
187
|
+
*
|
|
188
|
+
* @examplePrompt Delete the top floor
|
|
189
|
+
* @examplePrompt Remove the basement level
|
|
190
|
+
* @examplePrompt Get rid of storey 3
|
|
191
|
+
* @examplePrompt Delete the second floor and everything on it
|
|
192
|
+
*
|
|
193
|
+
* # Example
|
|
194
|
+
* ```ts
|
|
195
|
+
* const { newActiveStory } = await snaptrude.core.storeys.delete(3)
|
|
196
|
+
* console.log(`Deleted storey 3; now on storey ${newActiveStory}`)
|
|
197
|
+
* ```
|
|
198
|
+
*/
|
|
199
|
+
abstract delete(storyValue: number): PluginApiReturn<PluginStoryDeleteResult>;
|
|
200
|
+
/**
|
|
201
|
+
* Copy a storey into the adjacent level, up or down.
|
|
202
|
+
*
|
|
203
|
+
* By default the **whole storey** is copied: every eligible element on the
|
|
204
|
+
* active storey (walls, floors, roofs, masses, columns, beams, staircases,
|
|
205
|
+
* ceilings, parametric curtain walls, and furniture) is copied into the storey
|
|
206
|
+
* one level `"up"` or `"down"`. Pass `options.components` to copy only a subset
|
|
207
|
+
* instead. The target storey is **created automatically** if it does not yet
|
|
208
|
+
* exist, inheriting the source storey's height.
|
|
209
|
+
*
|
|
210
|
+
* Copies are **instanced** by default (`unique: false`) — they share geometry
|
|
211
|
+
* with the source, so later edits propagate. Set `unique: true` for independent
|
|
212
|
+
* geometry. Doors and windows are never copied on their own; they ride along
|
|
213
|
+
* with their host wall. Locked, throw-away, and unsupported elements are skipped
|
|
214
|
+
* and counted in `skipped`. The whole operation is a single undo step.
|
|
215
|
+
*
|
|
216
|
+
* @param direction - `"up"` to copy into the storey above, `"down"` for below
|
|
217
|
+
* @param options - `components` (restrict to a subset of the storey's elements;
|
|
218
|
+
* omit for the whole storey) and `unique` (default `false` = instanced copies;
|
|
219
|
+
* `true` = independent geometry)
|
|
220
|
+
* @returns A {@linkcode PluginStoryDuplicateResult} with the `sourceStory`, the
|
|
221
|
+
* `targetStories` the copies landed on, the `created` component handles, the
|
|
222
|
+
* `createdStoryValues` for any storeys generated to receive them, and the
|
|
223
|
+
* `skipped` count of ineligible elements
|
|
224
|
+
* @throws `NO_ACTIVE_STRUCTURE` if there is no active structure to copy into;
|
|
225
|
+
* `NO_ELIGIBLE_ELEMENTS` if nothing on the source storey (or in
|
|
226
|
+
* `options.components`) is copyable; `HANDLE_INVALID` for a stale or foreign
|
|
227
|
+
* supplied handle; or if plugin writes are disabled
|
|
228
|
+
*
|
|
229
|
+
* @examplePrompt Copy this floor to the storey above
|
|
230
|
+
* @examplePrompt Copy the ground floor down into a new basement
|
|
231
|
+
* @examplePrompt Repeat this level upwards with its own independent geometry
|
|
232
|
+
* @examplePrompt Copy just the selected walls onto the next floor up
|
|
233
|
+
*
|
|
234
|
+
* # Example
|
|
235
|
+
* ```ts
|
|
236
|
+
* // Copy the whole active storey one level up (instanced copies).
|
|
237
|
+
* const { targetStories, created, skipped } =
|
|
238
|
+
* await snaptrude.core.storeys.copy("up")
|
|
239
|
+
* console.log(`Copied ${created.length} elements onto storey ${targetStories}`)
|
|
240
|
+
* if (skipped) console.log(`${skipped} elements were skipped`)
|
|
241
|
+
* ```
|
|
242
|
+
*/
|
|
243
|
+
abstract copy(direction: "up" | "down", options?: {
|
|
244
|
+
components?: ComponentHandle[];
|
|
245
|
+
unique?: boolean;
|
|
246
|
+
}): PluginApiReturn<PluginStoryDuplicateResult>;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Result of {@linkcode PluginCoreStoreysApi.list} — the {@linkcode PluginStoryGetAllResult}
|
|
250
|
+
* shape with the array field renamed `stories` → `storeys`. Each entry shares the
|
|
251
|
+
* same element type: `{ value, id, name }`, sorted top to bottom.
|
|
252
|
+
*
|
|
253
|
+
* | Property | Type | Description |
|
|
254
|
+
* |---|---|---|
|
|
255
|
+
* | `storeys` | `Array<{ value, id, name }>` | All storeys, sorted top to bottom |
|
|
256
|
+
*/
|
|
257
|
+
export declare const PluginCoreStoreysListResult: z.ZodObject<{
|
|
258
|
+
storeys: z.ZodArray<z.ZodObject<{
|
|
259
|
+
value: z.ZodNumber;
|
|
260
|
+
id: z.ZodString;
|
|
261
|
+
name: z.ZodString;
|
|
262
|
+
}, z.core.$strip>>;
|
|
263
|
+
}, z.core.$strip>;
|
|
264
|
+
export type PluginCoreStoreysListResult = z.infer<typeof PluginCoreStoreysListResult>;
|
|
265
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/storeys/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAEpB,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,oBAAoB,CAAA;AAE3B;;;;;;;;;;;;;GAaG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,IAAI,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;OAYG;aACa,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,IAAI,CAClB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAEtC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA"}
|
package/dist/api/core/tags.d.ts
CHANGED
|
@@ -119,8 +119,32 @@ export declare abstract class PluginCoreTagsApi {
|
|
|
119
119
|
* const { tags } = await snaptrude.core.tags.getTagsForComponent("cmp_42")
|
|
120
120
|
* for (const t of tags) console.log(t.categoryName, t.tagName)
|
|
121
121
|
* ```
|
|
122
|
+
*
|
|
123
|
+
* @deprecated Use `core.tags.listForComponent`
|
|
122
124
|
*/
|
|
123
125
|
abstract getTagsForComponent(componentId: ComponentHandle): PluginApiReturn<PluginCoreTagsGetTagsForComponentResult>;
|
|
126
|
+
/**
|
|
127
|
+
* List the tags carried by a component.
|
|
128
|
+
*
|
|
129
|
+
* Returns one entry per category the component is tagged in, each carrying the
|
|
130
|
+
* category and tag names and the tag color. Canonical home of the read formerly
|
|
131
|
+
* at `getTagsForComponent` (now deprecated).
|
|
132
|
+
*
|
|
133
|
+
* @param componentId - The `Component.id` to read.
|
|
134
|
+
* @returns A {@linkcode PluginCoreTagsGetTagsForComponentResult} with a `tags`
|
|
135
|
+
* array (empty when the component has none or does not exist).
|
|
136
|
+
*
|
|
137
|
+
* @examplePrompt What tags does this space have?
|
|
138
|
+
* @examplePrompt List the tags on component cmp_42
|
|
139
|
+
* @examplePrompt Show the labels applied to this room
|
|
140
|
+
*
|
|
141
|
+
* # Example
|
|
142
|
+
* ```ts
|
|
143
|
+
* const { tags } = await snaptrude.core.tags.listForComponent("cmp_42")
|
|
144
|
+
* for (const t of tags) console.log(t.categoryName, t.tagName)
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
abstract listForComponent(componentId: ComponentHandle): PluginApiReturn<PluginCoreTagsGetTagsForComponentResult>;
|
|
124
148
|
/**
|
|
125
149
|
* List the components carrying a given tag or category.
|
|
126
150
|
*
|
|
@@ -1 +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
|
|
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"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../types";
|
|
3
|
+
/**
|
|
4
|
+
* User locale.
|
|
5
|
+
*
|
|
6
|
+
* Read the viewer's timezone and language — for date/number formatting and
|
|
7
|
+
* localized labels. This is locale only: NO precise geolocation, no IP, no
|
|
8
|
+
* account identity. Accessed via `snaptrude.core.user`.
|
|
9
|
+
*/
|
|
10
|
+
export declare abstract class PluginUserApi {
|
|
11
|
+
constructor();
|
|
12
|
+
/**
|
|
13
|
+
* Get the viewer's locale: IANA timezone and BCP-47 language tag, resolved
|
|
14
|
+
* from the browser (`Intl.DateTimeFormat().resolvedOptions().timeZone` and
|
|
15
|
+
* `navigator.language`). Locale only — no precise location.
|
|
16
|
+
*
|
|
17
|
+
* @returns `{ timezone, language }` — e.g. `{ timezone: "Asia/Kolkata", language: "en-US" }`.
|
|
18
|
+
*
|
|
19
|
+
* @examplePrompt What timezone is the user in?
|
|
20
|
+
* @examplePrompt Get the viewer's language for localized labels
|
|
21
|
+
* @examplePrompt Format the report date in the user's local timezone
|
|
22
|
+
* @examplePrompt Which locale should I use for this plugin's UI?
|
|
23
|
+
*
|
|
24
|
+
* # Example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const { timezone, language } = await snaptrude.core.user.getLocale()
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
abstract getLocale(): PluginApiReturn<PluginUserLocale>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The viewer's locale.
|
|
33
|
+
*
|
|
34
|
+
* | Property | Type | Description |
|
|
35
|
+
* |---|---|---|
|
|
36
|
+
* | `timezone` | `string` | IANA timezone id (e.g. `"Asia/Kolkata"`) |
|
|
37
|
+
* | `language` | `string` | BCP-47 language tag (e.g. `"en-US"`) |
|
|
38
|
+
*/
|
|
39
|
+
export declare const PluginUserLocale: z.ZodObject<{
|
|
40
|
+
timezone: z.ZodString;
|
|
41
|
+
language: z.ZodString;
|
|
42
|
+
}, z.core.$strip>;
|
|
43
|
+
export type PluginUserLocale = z.infer<typeof PluginUserLocale>;
|
|
44
|
+
//# sourceMappingURL=user.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/api/core/user.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;GAMG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,IAAI,eAAe,CAAC,gBAAgB,CAAC;CAC/D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
|
|
@@ -22,6 +22,8 @@ export declare abstract class PluginZoomApi {
|
|
|
22
22
|
* ```ts
|
|
23
23
|
* await snaptrude.core.zoom.extents()
|
|
24
24
|
* ```
|
|
25
|
+
*
|
|
26
|
+
* @deprecated Use `core.camera.zoomExtents`
|
|
25
27
|
*/
|
|
26
28
|
abstract extents(): PluginApiReturn<boolean>;
|
|
27
29
|
/**
|
|
@@ -39,6 +41,8 @@ export declare abstract class PluginZoomApi {
|
|
|
39
41
|
* ```ts
|
|
40
42
|
* await snaptrude.core.zoom.selection()
|
|
41
43
|
* ```
|
|
44
|
+
*
|
|
45
|
+
* @deprecated Use `core.camera.zoomSelection`
|
|
42
46
|
*/
|
|
43
47
|
abstract selection(): PluginApiReturn<boolean>;
|
|
44
48
|
}
|
|
@@ -1 +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
|
|
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"}
|
|
@@ -115,7 +115,7 @@ export declare abstract class PluginDesignBooleanApi {
|
|
|
115
115
|
* | `offset` | {@linkcode Vec3Handle} | Translation added to the created result mass(es) (default: none) |
|
|
116
116
|
*/
|
|
117
117
|
export declare const BooleanOptions: z.ZodObject<{
|
|
118
|
-
offset: z.ZodOptional<z.ZodPipe<z.
|
|
118
|
+
offset: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
119
119
|
}, z.core.$strip>;
|
|
120
120
|
export type BooleanOptions = z.infer<typeof BooleanOptions>;
|
|
121
121
|
/**
|
|
@@ -129,7 +129,7 @@ export type BooleanOptions = z.infer<typeof BooleanOptions>;
|
|
|
129
129
|
export declare const PluginDesignBooleanUnionArgs: z.ZodObject<{
|
|
130
130
|
components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
131
131
|
options: z.ZodOptional<z.ZodObject<{
|
|
132
|
-
offset: z.ZodOptional<z.ZodPipe<z.
|
|
132
|
+
offset: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
133
133
|
}, z.core.$strip>>;
|
|
134
134
|
}, z.core.$strip>;
|
|
135
135
|
export type PluginDesignBooleanUnionArgs = z.infer<typeof PluginDesignBooleanUnionArgs>;
|
|
@@ -146,7 +146,7 @@ export declare const PluginDesignBooleanSubtractArgs: z.ZodObject<{
|
|
|
146
146
|
target: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
147
147
|
tools: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
148
148
|
options: z.ZodOptional<z.ZodObject<{
|
|
149
|
-
offset: z.ZodOptional<z.ZodPipe<z.
|
|
149
|
+
offset: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
150
150
|
}, z.core.$strip>>;
|
|
151
151
|
}, z.core.$strip>;
|
|
152
152
|
export type PluginDesignBooleanSubtractArgs = z.infer<typeof PluginDesignBooleanSubtractArgs>;
|
|
@@ -161,7 +161,7 @@ export type PluginDesignBooleanSubtractArgs = z.infer<typeof PluginDesignBoolean
|
|
|
161
161
|
export declare const PluginDesignBooleanIntersectArgs: z.ZodObject<{
|
|
162
162
|
components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
163
163
|
options: z.ZodOptional<z.ZodObject<{
|
|
164
|
-
offset: z.ZodOptional<z.ZodPipe<z.
|
|
164
|
+
offset: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
165
165
|
}, z.core.$strip>>;
|
|
166
166
|
}, z.core.$strip>;
|
|
167
167
|
export type PluginDesignBooleanIntersectArgs = z.infer<typeof PluginDesignBooleanIntersectArgs>;
|