@snaptrude/plugin-core 0.0.0-dev-20260708130115 → 0.0.0-dev-20260827194031
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 +3643 -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 +493 -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 +289 -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 +4605 -1423
- 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 +4191 -1412
- 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 +544 -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 +219 -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,126 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../types";
|
|
3
|
+
import { ComponentHandle } from "../../handles";
|
|
4
|
+
import { PluginDesignChangeResult } from "./lock";
|
|
5
|
+
/**
|
|
6
|
+
* `snaptrude.design.visibility.*` — hide, isolate, and reveal scene entities.
|
|
7
|
+
*
|
|
8
|
+
* Visibility is a per-component user flag (the same one the "Hide" / "Isolate" /
|
|
9
|
+
* "Show All" toolbar and right-click actions toggle). Every method here commits
|
|
10
|
+
* an undoable command and echoes the affected entities as
|
|
11
|
+
* {@linkcode PluginDesignChangeResult}.
|
|
12
|
+
*
|
|
13
|
+
* Accessed via `snaptrude.design.visibility`.
|
|
14
|
+
*/
|
|
15
|
+
export declare abstract class PluginDesignVisibilityApi {
|
|
16
|
+
constructor();
|
|
17
|
+
/**
|
|
18
|
+
* Hide entities from the viewport — the same as the "Hide" action. Undoable.
|
|
19
|
+
* Hosted door/window/void children ride along with their wall. Already-hidden
|
|
20
|
+
* entities stay hidden.
|
|
21
|
+
*
|
|
22
|
+
* @param components Entities to hide
|
|
23
|
+
* @returns The affected entities (echoing the input handles)
|
|
24
|
+
*
|
|
25
|
+
* @examplePrompt Hide the selected walls
|
|
26
|
+
* @examplePrompt Conceal these masses so I can see behind them
|
|
27
|
+
* @examplePrompt Hide every column on this floor
|
|
28
|
+
* @examplePrompt Make this furniture disappear from view
|
|
29
|
+
*
|
|
30
|
+
* # Example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const walls = await snaptrude.design.query.listWalls({ storeys: [1] })
|
|
33
|
+
* const { affected } = await snaptrude.design.visibility.hide(walls)
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
abstract hide(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
|
|
37
|
+
/**
|
|
38
|
+
* Reveal specific hidden components — the inverse of
|
|
39
|
+
* {@linkcode PluginDesignVisibilityApi.hide}. Use
|
|
40
|
+
* {@linkcode PluginDesignVisibilityApi.showAll} to reveal everything.
|
|
41
|
+
*
|
|
42
|
+
* @param components - The components to reveal.
|
|
43
|
+
* @returns A {@linkcode PluginDesignChangeResult} echoing the components shown.
|
|
44
|
+
*
|
|
45
|
+
* @examplePrompt Show these walls again
|
|
46
|
+
* @examplePrompt Unhide the selected furniture
|
|
47
|
+
*
|
|
48
|
+
* # Example
|
|
49
|
+
* ```ts
|
|
50
|
+
* await snaptrude.design.visibility.show([wall])
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
abstract show(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
|
|
54
|
+
/**
|
|
55
|
+
* Isolate entities — hide everything else so only the given entities remain
|
|
56
|
+
* visible (the "Isolate" / solo action). Undoable. Reverse it with
|
|
57
|
+
* {@linkcode PluginDesignVisibilityApi.showAll}.
|
|
58
|
+
*
|
|
59
|
+
* @param components Entities to keep visible; everything else is hidden
|
|
60
|
+
* @returns The isolated entities (echoing the input handles)
|
|
61
|
+
*
|
|
62
|
+
* @examplePrompt Isolate the selected room so I can focus on it
|
|
63
|
+
* @examplePrompt Show only these walls and hide the rest
|
|
64
|
+
* @examplePrompt Solo this mass
|
|
65
|
+
* @examplePrompt Hide everything except the staircase
|
|
66
|
+
*
|
|
67
|
+
* # Example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const [room] = await snaptrude.design.selection.get()
|
|
70
|
+
* await snaptrude.design.visibility.isolate([room])
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
abstract isolate(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
|
|
74
|
+
/**
|
|
75
|
+
* Reveal everything hidden on the active story — the "Show All" action, which
|
|
76
|
+
* also exits an isolate. Undoable.
|
|
77
|
+
*
|
|
78
|
+
* @returns The entities that were made visible
|
|
79
|
+
*
|
|
80
|
+
* @examplePrompt Show everything again
|
|
81
|
+
* @examplePrompt Unhide all the hidden objects
|
|
82
|
+
* @examplePrompt Exit isolate mode
|
|
83
|
+
* @examplePrompt Reveal everything I hid earlier
|
|
84
|
+
*
|
|
85
|
+
* # Example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const { affected } = await snaptrude.design.visibility.showAll()
|
|
88
|
+
* console.log(`Revealed ${affected.length} entities`)
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
abstract showAll(): PluginApiReturn<PluginDesignChangeResult>;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Arguments for {@linkcode PluginDesignVisibilityApi.hide}.
|
|
95
|
+
*
|
|
96
|
+
* | Property | Type | Description |
|
|
97
|
+
* |---|---|---|
|
|
98
|
+
* | `components` | {@linkcode ComponentHandle}`[]` | Entities to hide |
|
|
99
|
+
*/
|
|
100
|
+
export declare const PluginDesignVisibilityHideArgs: z.ZodObject<{
|
|
101
|
+
components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
102
|
+
}, z.core.$strip>;
|
|
103
|
+
export type PluginDesignVisibilityHideArgs = z.infer<typeof PluginDesignVisibilityHideArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Arguments for {@linkcode PluginDesignVisibilityApi.show}.
|
|
106
|
+
*
|
|
107
|
+
* | Property | Type | Description |
|
|
108
|
+
* |---|---|---|
|
|
109
|
+
* | `components` | {@linkcode ComponentHandle}`[]` | Entities to reveal |
|
|
110
|
+
*/
|
|
111
|
+
export declare const PluginDesignVisibilityShowArgs: z.ZodObject<{
|
|
112
|
+
components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
113
|
+
}, z.core.$strip>;
|
|
114
|
+
export type PluginDesignVisibilityShowArgs = z.infer<typeof PluginDesignVisibilityShowArgs>;
|
|
115
|
+
/**
|
|
116
|
+
* Arguments for {@linkcode PluginDesignVisibilityApi.isolate}.
|
|
117
|
+
*
|
|
118
|
+
* | Property | Type | Description |
|
|
119
|
+
* |---|---|---|
|
|
120
|
+
* | `components` | {@linkcode ComponentHandle}`[]` | Entities to keep visible |
|
|
121
|
+
*/
|
|
122
|
+
export declare const PluginDesignVisibilityIsolateArgs: z.ZodObject<{
|
|
123
|
+
components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
124
|
+
}, z.core.$strip>;
|
|
125
|
+
export type PluginDesignVisibilityIsolateArgs = z.infer<typeof PluginDesignVisibilityIsolateArgs>;
|
|
126
|
+
//# sourceMappingURL=visibility.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"visibility.d.ts","sourceRoot":"","sources":["../../../src/api/design/visibility.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;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;AAEjD;;;;;;;;;GASG;AACH,8BAAsB,yBAAyB;;IAG7C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CACrB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;aACa,OAAO,IAAI,eAAe,CAAC,wBAAwB,CAAC;CACrE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA"}
|
|
@@ -2,13 +2,20 @@ import * as z from "zod";
|
|
|
2
2
|
import { PluginApiReturn } from "../../../types";
|
|
3
3
|
import { ComponentHandle } from "../../../handles";
|
|
4
4
|
import { PluginDesignChangeResult } from "../lock";
|
|
5
|
+
import { PluginObjectCatalogGroup, PluginObjectCatalogItem } from "../doors";
|
|
5
6
|
/**
|
|
6
7
|
* `snaptrude.design.windows` — window-specific reads. Creation lives at
|
|
7
8
|
* `design.create.window`; generic reads (`listWindows`/`getHost`/`getProperties`) live
|
|
8
9
|
* at `design.query.*`. Window targets are {@linkcode ComponentHandle}s.
|
|
9
10
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
11
|
+
* The **catalog** reads (`listCatalogGroups`/`listCatalog`/`getCatalogItem`/`exists`)
|
|
12
|
+
* browse the placeable window library — plain value records keyed by a library id
|
|
13
|
+
* (team `_id` or general `fullName`), NOT handles — and feed `design.create.window`.
|
|
14
|
+
* They are network-backed but carry no `Async` suffix (§6.6) and never throw
|
|
15
|
+
* (`[]`/`null`). The {@linkcode PluginObjectCatalogGroup} / {@linkcode PluginObjectCatalogItem}
|
|
16
|
+
* DTOs are shared with `design.doors` (defined there, re-exported here).
|
|
17
|
+
*
|
|
18
|
+
* `getSillHeight` (bounds-derived) and the command-wired `mirror` land in a later pass.
|
|
12
19
|
*/
|
|
13
20
|
export declare abstract class PluginDesignWindowsApi {
|
|
14
21
|
constructor();
|
|
@@ -133,6 +140,83 @@ export declare abstract class PluginDesignWindowsApi {
|
|
|
133
140
|
* ```
|
|
134
141
|
*/
|
|
135
142
|
abstract setHeight(window: ComponentHandle, height: number): PluginApiReturn<PluginDesignChangeResult>;
|
|
143
|
+
/**
|
|
144
|
+
* List the window catalog **groups** — the placement families (Fixed,
|
|
145
|
+
* Casement, Sliding, Folding, …), built-in groups merged with any
|
|
146
|
+
* team-custom types.
|
|
147
|
+
*
|
|
148
|
+
* @returns The groups as {@linkcode PluginObjectCatalogGroup}`[]` (`[]` when empty)
|
|
149
|
+
*
|
|
150
|
+
* @examplePrompt What kinds of windows can I place?
|
|
151
|
+
* @examplePrompt List the window groups in the catalog
|
|
152
|
+
* @examplePrompt Show me the window families available in this project
|
|
153
|
+
* @examplePrompt Which window types does this project support?
|
|
154
|
+
*
|
|
155
|
+
* # Example
|
|
156
|
+
* ```ts
|
|
157
|
+
* const groups = await snaptrude.design.windows.listCatalogGroups()
|
|
158
|
+
* for (const g of groups) console.log(g.dbType, g.label, g.source)
|
|
159
|
+
* ```
|
|
160
|
+
*/
|
|
161
|
+
abstract listCatalogGroups(): PluginApiReturn<PluginObjectCatalogGroup[]>;
|
|
162
|
+
/**
|
|
163
|
+
* List the placeable window catalog (team + general libraries), optionally
|
|
164
|
+
* restricted to one group by its `dbType` token.
|
|
165
|
+
*
|
|
166
|
+
* @param group Restrict to one group's `dbType` (optional; e.g. `"casementDouble"`)
|
|
167
|
+
* @returns The catalog as {@linkcode PluginObjectCatalogItem}`[]` (`[]` when empty)
|
|
168
|
+
*
|
|
169
|
+
* @examplePrompt What windows can I place in this project?
|
|
170
|
+
* @examplePrompt List every window in the library
|
|
171
|
+
* @examplePrompt Show me the casement windows I can add
|
|
172
|
+
* @examplePrompt Browse the window catalog
|
|
173
|
+
*
|
|
174
|
+
* # Example
|
|
175
|
+
* ```ts
|
|
176
|
+
* const [group] = await snaptrude.design.windows.listCatalogGroups()
|
|
177
|
+
* const items = await snaptrude.design.windows.listCatalog(group?.dbType)
|
|
178
|
+
* for (const item of items) console.log(item.id, item.name, item.thumbnailUrl)
|
|
179
|
+
* ```
|
|
180
|
+
*/
|
|
181
|
+
abstract listCatalog(group?: string): PluginApiReturn<PluginObjectCatalogItem[]>;
|
|
182
|
+
/**
|
|
183
|
+
* Get a single window catalog item by its library id.
|
|
184
|
+
*
|
|
185
|
+
* @param id The catalog library id
|
|
186
|
+
* @returns The item, or `null` if no catalog item matches
|
|
187
|
+
*
|
|
188
|
+
* @examplePrompt Get the details of this window from the library
|
|
189
|
+
* @examplePrompt Look up the catalog entry for this window id
|
|
190
|
+
* @examplePrompt What is the cost of this window item?
|
|
191
|
+
* @examplePrompt Show me the family name of this window in the catalog
|
|
192
|
+
*
|
|
193
|
+
* # Example
|
|
194
|
+
* ```ts
|
|
195
|
+
* const [entry] = await snaptrude.design.windows.listCatalog()
|
|
196
|
+
* const item = await snaptrude.design.windows.getCatalogItem(entry.id)
|
|
197
|
+
* if (item) console.log(item.name, item.source, item.dbType)
|
|
198
|
+
* ```
|
|
199
|
+
*/
|
|
200
|
+
abstract getCatalogItem(id: string): PluginApiReturn<PluginObjectCatalogItem | null>;
|
|
201
|
+
/**
|
|
202
|
+
* Test whether a window catalog item exists for the given library id.
|
|
203
|
+
*
|
|
204
|
+
* @param id The catalog library id
|
|
205
|
+
* @returns `true` if it exists, otherwise `false`
|
|
206
|
+
*
|
|
207
|
+
* @examplePrompt Is this window still in the library?
|
|
208
|
+
* @examplePrompt Check whether a window catalog item with this id exists
|
|
209
|
+
* @examplePrompt Does my team library have this window?
|
|
210
|
+
* @examplePrompt Verify the window is available before placing it
|
|
211
|
+
*
|
|
212
|
+
* # Example
|
|
213
|
+
* ```ts
|
|
214
|
+
* const [entry] = await snaptrude.design.windows.listCatalog()
|
|
215
|
+
* const stillAvailable = await snaptrude.design.windows.exists(entry.id)
|
|
216
|
+
* console.log(stillAvailable ? "safe to place" : "removed from library")
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
abstract exists(id: string): PluginApiReturn<boolean>;
|
|
136
220
|
}
|
|
137
221
|
/**
|
|
138
222
|
* Arguments for the single-window read methods.
|
|
@@ -186,4 +270,31 @@ export declare const PluginDesignWindowSetHeightArgs: z.ZodObject<{
|
|
|
186
270
|
height: z.ZodNumber;
|
|
187
271
|
}, z.core.$strip>;
|
|
188
272
|
export type PluginDesignWindowSetHeightArgs = z.infer<typeof PluginDesignWindowSetHeightArgs>;
|
|
273
|
+
export { PluginObjectCatalogGroup, PluginObjectCatalogItem };
|
|
274
|
+
/**
|
|
275
|
+
* Arguments for {@linkcode PluginDesignWindowsApi.listCatalog}.
|
|
276
|
+
*
|
|
277
|
+
* | Property | Type | Description |
|
|
278
|
+
* |---|---|---|
|
|
279
|
+
* | `group` | `string`? | Restrict to one group's `dbType` token (optional) |
|
|
280
|
+
*/
|
|
281
|
+
export declare const PluginDesignWindowListCatalogArgs: z.ZodObject<{
|
|
282
|
+
group: z.ZodOptional<z.ZodString>;
|
|
283
|
+
}, z.core.$strip>;
|
|
284
|
+
export type PluginDesignWindowListCatalogArgs = z.infer<typeof PluginDesignWindowListCatalogArgs>;
|
|
285
|
+
/**
|
|
286
|
+
* Arguments for {@linkcode PluginDesignWindowsApi.getCatalogItem} / {@linkcode PluginDesignWindowsApi.exists}.
|
|
287
|
+
*
|
|
288
|
+
* | Property | Type | Description |
|
|
289
|
+
* |---|---|---|
|
|
290
|
+
* | `id` | `string` | The catalog library id |
|
|
291
|
+
*/
|
|
292
|
+
export declare const PluginDesignWindowGetCatalogItemArgs: z.ZodObject<{
|
|
293
|
+
id: z.ZodString;
|
|
294
|
+
}, z.core.$strip>;
|
|
295
|
+
export type PluginDesignWindowGetCatalogItemArgs = z.infer<typeof PluginDesignWindowGetCatalogItemArgs>;
|
|
296
|
+
export declare const PluginDesignWindowExistsArgs: z.ZodObject<{
|
|
297
|
+
id: z.ZodString;
|
|
298
|
+
}, z.core.$strip>;
|
|
299
|
+
export type PluginDesignWindowExistsArgs = z.infer<typeof PluginDesignWindowExistsArgs>;
|
|
189
300
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/windows/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,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/windows/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,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAE5E;;;;;;;;;;;;;GAaG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhF;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjF;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAElF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,aAAa,CAC3B,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,QAAQ,CACtB,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,CACvB,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;OAiBG;aACa,iBAAiB,IAAI,eAAe,CAAC,wBAAwB,EAAE,CAAC;IAEhF;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAE7C;;;;;;;;;;;;;;;;;OAiBG;aACa,cAAc,CAC5B,EAAE,EAAE,MAAM,GACT,eAAe,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAElD;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;;;iBAIjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B;;;iBAGzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAO7F,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAEjG;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEvG,eAAO,MAAM,4BAA4B;;iBAAuC,CAAA;AAChF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}
|
|
@@ -52,6 +52,8 @@ export declare abstract class PluginBuildableEnvelopeApi {
|
|
|
52
52
|
* 12,
|
|
53
53
|
* )
|
|
54
54
|
* ```
|
|
55
|
+
*
|
|
56
|
+
* @deprecated Use `design.create.buildableEnvelope`
|
|
55
57
|
*/
|
|
56
58
|
abstract create(sitePolygon: PluginBuildableEnvelopePolygonVertex[], lengthUnit: "ft" | "m", setbacks: PluginBuildableEnvelopeSetbackTier[], verticalCap: PluginBuildableEnvelopeVerticalCap, floorToFloor: number, farRatio?: number, lotCoverageMaxPct?: number): PluginApiReturn<PluginBuildableEnvelopeCreateResult>;
|
|
57
59
|
/**
|
|
@@ -95,6 +97,8 @@ export declare abstract class PluginBuildableEnvelopeApi {
|
|
|
95
97
|
* 12,
|
|
96
98
|
* )
|
|
97
99
|
* ```
|
|
100
|
+
*
|
|
101
|
+
* @deprecated Use `design.update.buildableEnvelope`
|
|
98
102
|
*/
|
|
99
103
|
abstract update(buildableEnvelopeId: string, sitePolygon: PluginBuildableEnvelopePolygonVertex[], lengthUnit: "ft" | "m", setbacks: PluginBuildableEnvelopeSetbackTier[], verticalCap: PluginBuildableEnvelopeVerticalCap, floorToFloor: number, farRatio?: number, lotCoverageMaxPct?: number): PluginApiReturn<PluginBuildableEnvelopeUpdateResult>;
|
|
100
104
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buildableEnvelope.d.ts","sourceRoot":"","sources":["../../../src/api/entity/buildableEnvelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,0BAA0B;;IAG9C
|
|
1
|
+
{"version":3,"file":"buildableEnvelope.d.ts","sourceRoot":"","sources":["../../../src/api/entity/buildableEnvelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,MAAM,CACpB,WAAW,EAAE,oCAAoC,EAAE,EACnD,UAAU,EAAE,IAAI,GAAG,GAAG,EACtB,QAAQ,EAAE,kCAAkC,EAAE,EAC9C,WAAW,EAAE,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,GACzB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;aACa,MAAM,CACpB,mBAAmB,EAAE,MAAM,EAC3B,WAAW,EAAE,oCAAoC,EAAE,EACnD,UAAU,EAAE,IAAI,GAAG,GAAG,EACtB,QAAQ,EAAE,kCAAkC,EAAE,EAC9C,WAAW,EAAE,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,GACzB,eAAe,CAAC,mCAAmC,CAAC;CACxD;AAED;;;;;GAKG;AACH,eAAO,MAAM,oCAAoC;;;kEAG/C,CAAA;AAEF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,kCAAkC;;;;;;4BAS7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kCAAkC;;;;;kBAKpC,CAAA;AAEX,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AA+BD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;kBAWZ,CAAA;AAElC,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;kBAErC,CAAA;AAEX,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;kBAYZ,CAAA;AAElC,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;kBAErC,CAAA;AAEX,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA"}
|
|
@@ -47,6 +47,8 @@ export declare abstract class PluginReferenceLineApi {
|
|
|
47
47
|
*
|
|
48
48
|
* const { referenceLineIds } = await snaptrude.entity.referenceLine.createMulti(profile)
|
|
49
49
|
* ```
|
|
50
|
+
*
|
|
51
|
+
* @deprecated Use `design.create.referenceLines`
|
|
50
52
|
*/
|
|
51
53
|
abstract createMulti(profile: ProfileHandle): PluginApiReturn<PluginReferenceLineCreateMultiResult>;
|
|
52
54
|
/**
|
|
@@ -73,6 +75,8 @@ export declare abstract class PluginReferenceLineApi {
|
|
|
73
75
|
* // result.curve is an opaque CurveHandle; a dedicated curve read API for its
|
|
74
76
|
* // coordinates is exposed separately via `snaptrude.core.geom.curve`.
|
|
75
77
|
* ```
|
|
78
|
+
*
|
|
79
|
+
* @deprecated Use `design.query.referenceLines.get`
|
|
76
80
|
*/
|
|
77
81
|
abstract get(referenceLineId: string, properties: z.infer<typeof PluginReferenceLineGetProperty>[]): PluginApiReturn<PluginReferenceLineGetResult>;
|
|
78
82
|
/**
|
|
@@ -95,6 +99,8 @@ export declare abstract class PluginReferenceLineApi {
|
|
|
95
99
|
* const { referenceLineIds } = await snaptrude.entity.referenceLine.getAll()
|
|
96
100
|
* console.log(`Project has ${referenceLineIds.length} reference lines`)
|
|
97
101
|
* ```
|
|
102
|
+
*
|
|
103
|
+
* @deprecated Use `design.query.listReferenceLines`
|
|
98
104
|
*/
|
|
99
105
|
abstract getAll(): PluginApiReturn<PluginReferenceLineGetAllResult>;
|
|
100
106
|
/**
|
|
@@ -115,6 +121,8 @@ export declare abstract class PluginReferenceLineApi {
|
|
|
115
121
|
* ```ts
|
|
116
122
|
* await snaptrude.entity.referenceLine.delete("some-ref-line-id")
|
|
117
123
|
* ```
|
|
124
|
+
*
|
|
125
|
+
* @deprecated Use `design.delete.entities`
|
|
118
126
|
*/
|
|
119
127
|
abstract delete(referenceLineId: string): PluginApiReturn<PluginReferenceLineDeleteResult>;
|
|
120
128
|
}
|
|
@@ -126,7 +134,7 @@ export declare abstract class PluginReferenceLineApi {
|
|
|
126
134
|
* | `profile` | {@linkcode ProfileHandle} | Profile handle whose curves define reference lines |
|
|
127
135
|
*/
|
|
128
136
|
export declare const PluginReferenceLineCreateMultiArgs: z.ZodObject<{
|
|
129
|
-
profile: z.ZodPipe<z.
|
|
137
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>;
|
|
130
138
|
}, z.core.$strip>;
|
|
131
139
|
export type PluginReferenceLineCreateMultiArgs = z.infer<typeof PluginReferenceLineCreateMultiArgs>;
|
|
132
140
|
/**
|
|
@@ -172,7 +180,7 @@ export type PluginReferenceLineGetArgs = z.infer<typeof PluginReferenceLineGetAr
|
|
|
172
180
|
* {@linkcode PluginReferenceLineGetArgs.properties} will be present.
|
|
173
181
|
*/
|
|
174
182
|
export declare const PluginReferenceLineGetResult: z.ZodObject<{
|
|
175
|
-
curve: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.
|
|
183
|
+
curve: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"arc">, string>>]>>;
|
|
176
184
|
}, z.core.$strip>;
|
|
177
185
|
export type PluginReferenceLineGetResult = z.infer<typeof PluginReferenceLineGetResult>;
|
|
178
186
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"referenceLine.d.ts","sourceRoot":"","sources":["../../../src/api/entity/referenceLine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAe,MAAM,eAAe,CAAA;AAE1D;;;;;;;;;;;GAWG;AACH,8BAAsB,sBAAsB;;IAG1C
|
|
1
|
+
{"version":3,"file":"referenceLine.d.ts","sourceRoot":"","sources":["../../../src/api/entity/referenceLine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAe,MAAM,eAAe,CAAA;AAE1D;;;;;;;;;;;GAWG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,WAAW,CACzB,OAAO,EAAE,aAAa,GACrB,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,GAAG,CACjB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,EAAE,GAC3D,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE1E;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,MAAM,CACpB,eAAe,EAAE,MAAM,GACtB,eAAe,CAAC,+BAA+B,CAAC;CACpD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AAEF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEvG;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;EAEzC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;iBAGrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B;;iBAI7B,CAAA;AAEZ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AAEF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AAEF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEzF,8FAA8F;AAC9F,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAAA"}
|
|
@@ -8,7 +8,7 @@ import * as z from "zod";
|
|
|
8
8
|
* | `dimensions` | `{ width, height, depth }` | Box dimensions in Babylon units |
|
|
9
9
|
*/
|
|
10
10
|
export declare const PluginSpaceCreateRectangularArgs: z.ZodObject<{
|
|
11
|
-
position: z.ZodPipe<z.
|
|
11
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
12
12
|
dimensions: z.ZodObject<{
|
|
13
13
|
width: z.ZodNumber;
|
|
14
14
|
height: z.ZodNumber;
|
|
@@ -38,10 +38,10 @@ export type PluginSpaceCreateRectangularResult = z.infer<typeof PluginSpaceCreat
|
|
|
38
38
|
* | `position` | {@linkcode Vec3Handle} | Offset position in Babylon units |
|
|
39
39
|
*/
|
|
40
40
|
export declare const PluginSpaceCreateFromProfileArgs: z.ZodObject<{
|
|
41
|
-
profile: z.ZodPipe<z.
|
|
42
|
-
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.
|
|
41
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>;
|
|
42
|
+
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>>>;
|
|
43
43
|
extrudeHeight: z.ZodNumber;
|
|
44
|
-
position: z.ZodPipe<z.
|
|
44
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
45
45
|
}, z.core.$strip>;
|
|
46
46
|
export type PluginSpaceCreateFromProfileArgs = z.infer<typeof PluginSpaceCreateFromProfileArgs>;
|
|
47
47
|
/**
|
|
@@ -66,7 +66,7 @@ export type PluginSpaceCreateFromProfileResult = z.infer<typeof PluginSpaceCreat
|
|
|
66
66
|
*/
|
|
67
67
|
export declare const PluginSpaceUpdateGeometryFromProfileArgs: z.ZodObject<{
|
|
68
68
|
spaceId: z.ZodString;
|
|
69
|
-
profile: z.ZodPipe<z.
|
|
69
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>;
|
|
70
70
|
extrudeHeight: z.ZodNumber;
|
|
71
71
|
}, z.core.$strip>;
|
|
72
72
|
export type PluginSpaceUpdateGeometryFromProfileArgs = z.infer<typeof PluginSpaceUpdateGeometryFromProfileArgs>;
|
|
@@ -130,9 +130,10 @@ export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<typeof PluginSp
|
|
|
130
130
|
export declare const PluginSpaceGetProperty: z.ZodEnum<{
|
|
131
131
|
profile: "profile";
|
|
132
132
|
type: "type";
|
|
133
|
-
position: "position";
|
|
134
133
|
id: "id";
|
|
134
|
+
position: "position";
|
|
135
135
|
name: "name";
|
|
136
|
+
storey: "storey";
|
|
136
137
|
height: "height";
|
|
137
138
|
depth: "depth";
|
|
138
139
|
innerProfiles: "innerProfiles";
|
|
@@ -142,7 +143,6 @@ export declare const PluginSpaceGetProperty: z.ZodEnum<{
|
|
|
142
143
|
massType: "massType";
|
|
143
144
|
spaceType: "spaceType";
|
|
144
145
|
areaClass: "areaClass";
|
|
145
|
-
storey: "storey";
|
|
146
146
|
departmentId: "departmentId";
|
|
147
147
|
departmentName: "departmentName";
|
|
148
148
|
departmentColor: "departmentColor";
|
|
@@ -166,9 +166,10 @@ export declare const PluginSpaceGetArgs: z.ZodObject<{
|
|
|
166
166
|
properties: z.ZodArray<z.ZodEnum<{
|
|
167
167
|
profile: "profile";
|
|
168
168
|
type: "type";
|
|
169
|
-
position: "position";
|
|
170
169
|
id: "id";
|
|
170
|
+
position: "position";
|
|
171
171
|
name: "name";
|
|
172
|
+
storey: "storey";
|
|
172
173
|
height: "height";
|
|
173
174
|
depth: "depth";
|
|
174
175
|
innerProfiles: "innerProfiles";
|
|
@@ -178,7 +179,6 @@ export declare const PluginSpaceGetArgs: z.ZodObject<{
|
|
|
178
179
|
massType: "massType";
|
|
179
180
|
spaceType: "spaceType";
|
|
180
181
|
areaClass: "areaClass";
|
|
181
|
-
storey: "storey";
|
|
182
182
|
departmentId: "departmentId";
|
|
183
183
|
departmentName: "departmentName";
|
|
184
184
|
departmentColor: "departmentColor";
|
|
@@ -300,8 +300,8 @@ export declare const PluginSpaceGetResult: z.ZodObject<{
|
|
|
300
300
|
y: z.ZodNumber;
|
|
301
301
|
z: z.ZodNumber;
|
|
302
302
|
}, z.core.$strip>>>;
|
|
303
|
-
profile: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.
|
|
304
|
-
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.
|
|
303
|
+
profile: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"arc">, string>>]>>>;
|
|
304
|
+
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"arc">, string>>]>>>>;
|
|
305
305
|
innerPlanPoints: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodObject<{
|
|
306
306
|
x: z.ZodNumber;
|
|
307
307
|
y: z.ZodNumber;
|
|
@@ -498,7 +498,7 @@ export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>;
|
|
|
498
498
|
*/
|
|
499
499
|
export declare const PluginSpaceBulkCreateItem: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
500
500
|
kind: z.ZodLiteral<"rectangular">;
|
|
501
|
-
position: z.ZodPipe<z.
|
|
501
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
502
502
|
dimensions: z.ZodObject<{
|
|
503
503
|
width: z.ZodNumber;
|
|
504
504
|
height: z.ZodNumber;
|
|
@@ -539,10 +539,10 @@ export declare const PluginSpaceBulkCreateItem: z.ZodDiscriminatedUnion<[z.ZodOb
|
|
|
539
539
|
}>, z.ZodUUID]>>;
|
|
540
540
|
}, z.core.$strip>, z.ZodObject<{
|
|
541
541
|
kind: z.ZodLiteral<"profile">;
|
|
542
|
-
profile: z.ZodPipe<z.
|
|
543
|
-
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.
|
|
542
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>;
|
|
543
|
+
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>>>;
|
|
544
544
|
extrudeHeight: z.ZodNumber;
|
|
545
|
-
position: z.ZodPipe<z.
|
|
545
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
546
546
|
room_type: z.ZodOptional<z.ZodString>;
|
|
547
547
|
spaceType: z.ZodOptional<z.ZodEnum<{
|
|
548
548
|
Room: "Room";
|
|
@@ -588,7 +588,7 @@ export type PluginSpaceBulkCreateItem = z.infer<typeof PluginSpaceBulkCreateItem
|
|
|
588
588
|
export declare const PluginSpaceBulkCreateArgs: z.ZodObject<{
|
|
589
589
|
items: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
590
590
|
kind: z.ZodLiteral<"rectangular">;
|
|
591
|
-
position: z.ZodPipe<z.
|
|
591
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
592
592
|
dimensions: z.ZodObject<{
|
|
593
593
|
width: z.ZodNumber;
|
|
594
594
|
height: z.ZodNumber;
|
|
@@ -629,10 +629,10 @@ export declare const PluginSpaceBulkCreateArgs: z.ZodObject<{
|
|
|
629
629
|
}>, z.ZodUUID]>>;
|
|
630
630
|
}, z.core.$strip>, z.ZodObject<{
|
|
631
631
|
kind: z.ZodLiteral<"profile">;
|
|
632
|
-
profile: z.ZodPipe<z.
|
|
633
|
-
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.
|
|
632
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>;
|
|
633
|
+
innerProfiles: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>>>;
|
|
634
634
|
extrudeHeight: z.ZodNumber;
|
|
635
|
-
position: z.ZodPipe<z.
|
|
635
|
+
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"vec3">, string>>;
|
|
636
636
|
room_type: z.ZodOptional<z.ZodString>;
|
|
637
637
|
spaceType: z.ZodOptional<z.ZodEnum<{
|
|
638
638
|
Room: "Room";
|
|
@@ -697,7 +697,7 @@ export type PluginSpaceBulkCreateResult = z.infer<typeof PluginSpaceBulkCreateRe
|
|
|
697
697
|
*/
|
|
698
698
|
export declare const PluginSpaceBulkUpdateItem: z.ZodObject<{
|
|
699
699
|
spaceId: z.ZodString;
|
|
700
|
-
profile: z.ZodOptional<z.ZodPipe<z.
|
|
700
|
+
profile: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>>;
|
|
701
701
|
extrudeHeight: z.ZodOptional<z.ZodNumber>;
|
|
702
702
|
properties: z.ZodOptional<z.ZodObject<{
|
|
703
703
|
room_type: z.ZodOptional<z.ZodString>;
|
|
@@ -751,7 +751,7 @@ export type PluginSpaceBulkUpdateItem = z.infer<typeof PluginSpaceBulkUpdateItem
|
|
|
751
751
|
export declare const PluginSpaceBulkUpdateArgs: z.ZodObject<{
|
|
752
752
|
items: z.ZodArray<z.ZodObject<{
|
|
753
753
|
spaceId: z.ZodString;
|
|
754
|
-
profile: z.ZodOptional<z.ZodPipe<z.
|
|
754
|
+
profile: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../..").Handle<"profile">, string>>>;
|
|
755
755
|
extrudeHeight: z.ZodOptional<z.ZodNumber>;
|
|
756
756
|
properties: z.ZodOptional<z.ZodObject<{
|
|
757
757
|
room_type: z.ZodOptional<z.ZodString>;
|