@snaptrude/plugin-core 0.2.1 → 0.2.3
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/AGENTS.md +30 -26
- package/CHANGELOG.md +13 -1
- package/dist/api/entity/buildableEnvelope.d.ts +233 -0
- package/dist/api/entity/buildableEnvelope.d.ts.map +1 -0
- package/dist/api/entity/index.d.ts +5 -0
- package/dist/api/entity/index.d.ts.map +1 -1
- package/dist/api/entity/space.d.ts +2 -2
- package/dist/api/entity/story.d.ts +2 -2
- package/dist/index.cjs +242 -154
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +234 -154
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/api/entity/buildableEnvelope.ts +277 -0
- package/src/api/entity/index.ts +5 -0
package/AGENTS.md
CHANGED
|
@@ -31,21 +31,22 @@ checklist:
|
|
|
31
31
|
Every abstract method in `plugin-core` has a concrete implementation in `plugin-client`.
|
|
32
32
|
The file structure mirrors this package 1:1:
|
|
33
33
|
|
|
34
|
-
| plugin-core source | plugin-client counterpart
|
|
35
|
-
| ------------------------------------- |
|
|
36
|
-
| `src/api/core/math/vec3.ts` | `src/api/core/math/vec3.ts`
|
|
37
|
-
| `src/api/core/math/quat.ts` | `src/api/core/math/quat.ts`
|
|
38
|
-
| `src/api/core/geom/line.ts` | `src/api/core/geom/line.ts`
|
|
39
|
-
| `src/api/core/geom/arc.ts` | `src/api/core/geom/arc.ts`
|
|
40
|
-
| `src/api/core/geom/curve.ts` | `src/api/core/geom/curve.ts`
|
|
41
|
-
| `src/api/core/geom/profile.ts` | `src/api/core/geom/profile.ts`
|
|
42
|
-
| `src/api/entity/space.ts` | `src/api/entity/space.ts`
|
|
43
|
-
| `src/api/entity/story.ts` | `src/api/entity/story.ts`
|
|
44
|
-
| `src/api/entity/referenceLine.ts` | `src/api/entity/referenceLine.ts`
|
|
45
|
-
| `src/api/entity/department.ts` | `src/api/entity/department.ts`
|
|
46
|
-
| `src/api/
|
|
47
|
-
| `src/api/tools/
|
|
48
|
-
| `src/api/
|
|
34
|
+
| plugin-core source | plugin-client counterpart |
|
|
35
|
+
| ------------------------------------- | ------------------------------------- |
|
|
36
|
+
| `src/api/core/math/vec3.ts` | `src/api/core/math/vec3.ts` |
|
|
37
|
+
| `src/api/core/math/quat.ts` | `src/api/core/math/quat.ts` |
|
|
38
|
+
| `src/api/core/geom/line.ts` | `src/api/core/geom/line.ts` |
|
|
39
|
+
| `src/api/core/geom/arc.ts` | `src/api/core/geom/arc.ts` |
|
|
40
|
+
| `src/api/core/geom/curve.ts` | `src/api/core/geom/curve.ts` |
|
|
41
|
+
| `src/api/core/geom/profile.ts` | `src/api/core/geom/profile.ts` |
|
|
42
|
+
| `src/api/entity/space.ts` | `src/api/entity/space.ts` |
|
|
43
|
+
| `src/api/entity/story.ts` | `src/api/entity/story.ts` |
|
|
44
|
+
| `src/api/entity/referenceLine.ts` | `src/api/entity/referenceLine.ts` |
|
|
45
|
+
| `src/api/entity/department.ts` | `src/api/entity/department.ts` |
|
|
46
|
+
| `src/api/entity/buildableEnvelope.ts` | `src/api/entity/buildableEnvelope.ts` |
|
|
47
|
+
| `src/api/tools/selection.ts` | `src/api/tools/selection.ts` |
|
|
48
|
+
| `src/api/tools/transform.ts` | `src/api/tools/transform.ts` |
|
|
49
|
+
| `src/api/units/index.ts` | `src/api/units/index.ts` |
|
|
49
50
|
|
|
50
51
|
- **New method**: Add the concrete implementation (pure math = direct impl; host API = `getHostApi().call(...)`)
|
|
51
52
|
- **Removed method**: Delete from client
|
|
@@ -68,6 +69,7 @@ the actual Snaptrude-internal implementation.
|
|
|
68
69
|
### 3. JSDoc — keep it complete
|
|
69
70
|
|
|
70
71
|
All public methods and types **must** have JSDoc with:
|
|
72
|
+
|
|
71
73
|
- A brief description
|
|
72
74
|
- `@param` for each parameter (with type and description)
|
|
73
75
|
- `@returns` description
|
|
@@ -91,17 +93,18 @@ In summary:
|
|
|
91
93
|
|
|
92
94
|
These are in-browser integration tests that exercise the plugin API end-to-end.
|
|
93
95
|
|
|
94
|
-
| plugin-core API module | Test file
|
|
95
|
-
| ----------------------------- |
|
|
96
|
-
| `core/math/*` | `tests/math.ts`
|
|
97
|
-
| `core/geom/*` | `tests/geom.ts`
|
|
98
|
-
| `entity/space.ts` | `tests/spaces.ts`
|
|
99
|
-
| `entity/story.ts` | `tests/story.ts`
|
|
100
|
-
| `entity/referenceLine.ts` | `tests/referenceLines.ts`
|
|
101
|
-
| `entity/department.ts` | `tests/departments.ts`
|
|
102
|
-
| `
|
|
103
|
-
| `tools/
|
|
104
|
-
| `
|
|
96
|
+
| plugin-core API module | Test file |
|
|
97
|
+
| ----------------------------- | ----------------------------- |
|
|
98
|
+
| `core/math/*` | `tests/math.ts` |
|
|
99
|
+
| `core/geom/*` | `tests/geom.ts` |
|
|
100
|
+
| `entity/space.ts` | `tests/spaces.ts` |
|
|
101
|
+
| `entity/story.ts` | `tests/story.ts` |
|
|
102
|
+
| `entity/referenceLine.ts` | `tests/referenceLines.ts` |
|
|
103
|
+
| `entity/department.ts` | `tests/departments.ts` |
|
|
104
|
+
| `entity/buildableEnvelope.ts` | `tests/buildableEnvelopes.ts` |
|
|
105
|
+
| `tools/selection.ts` | `tests/selection.ts` |
|
|
106
|
+
| `tools/transform.ts` | `tests/transform.ts` |
|
|
107
|
+
| `units/index.ts` | `tests/units.ts` |
|
|
105
108
|
|
|
106
109
|
- **New method**: Add test cases covering the new method
|
|
107
110
|
- **Removed method**: Remove corresponding tests
|
|
@@ -111,6 +114,7 @@ These are in-browser integration tests that exercise the plugin API end-to-end.
|
|
|
111
114
|
### 6. Host-side Jest unit tests
|
|
112
115
|
|
|
113
116
|
Some host implementations have co-located `.test.ts` files:
|
|
117
|
+
|
|
114
118
|
- `api/core/math/vec3.test.ts`, `quat.test.ts`
|
|
115
119
|
- `api/core/geom/line.test.ts`, `arc.test.ts`, `curve.test.ts`
|
|
116
120
|
- `api/units/index.test.ts`
|
package/CHANGELOG.md
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
1
|
# @snaptrude/plugin-core
|
|
2
2
|
|
|
3
|
+
## 0.2.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 647466b: fixed merge issues
|
|
8
|
+
|
|
9
|
+
## 0.2.2
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 064777a: buildable envelope apis
|
|
14
|
+
|
|
3
15
|
## 0.2.1
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
|
6
18
|
|
|
7
|
-
-
|
|
19
|
+
- 3b37f4a: added buildable envelop api
|
|
8
20
|
|
|
9
21
|
## 0.2.0
|
|
10
22
|
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../types";
|
|
3
|
+
/**
|
|
4
|
+
* Buildable Envelope management — create and update parametric zoning envelopes.
|
|
5
|
+
*
|
|
6
|
+
* A **buildable envelope** is the regulated volume inside which a building may
|
|
7
|
+
* be massed. The host owns envelope identity: {@linkcode PluginBuildableEnvelopeApi.create create}
|
|
8
|
+
* mints a `buildableEnvelopeId` and returns it; {@linkcode PluginBuildableEnvelopeApi.update update}
|
|
9
|
+
* requires that id to target the existing envelope.
|
|
10
|
+
*
|
|
11
|
+
* Accessed via `snaptrude.entity.buildableEnvelope`.
|
|
12
|
+
*/
|
|
13
|
+
export declare abstract class PluginBuildableEnvelopeApi {
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* Create a new parametric buildable envelope.
|
|
17
|
+
*
|
|
18
|
+
* @param args - A {@linkcode PluginBuildableEnvelopeCreateArgs} object.
|
|
19
|
+
* @returns A {@linkcode PluginBuildableEnvelopeCreateResult} with the
|
|
20
|
+
* `buildableEnvelopeId` of the created envelope.
|
|
21
|
+
* @throws If validation fails or generation produces no renderable geometry.
|
|
22
|
+
*
|
|
23
|
+
* # Example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const { buildableEnvelopeId } = await snaptrude.entity.buildableEnvelope.create({
|
|
26
|
+
* sitePolygon: [
|
|
27
|
+
* { x: 0, z: 0 },
|
|
28
|
+
* { x: 100, z: 0 },
|
|
29
|
+
* { x: 100, z: 80 },
|
|
30
|
+
* { x: 0, z: 80 },
|
|
31
|
+
* ],
|
|
32
|
+
* lengthUnit: "ft",
|
|
33
|
+
* setbacks: [
|
|
34
|
+
* { aboveHeight: 0, front: 10, side: 5, rear: 10 },
|
|
35
|
+
* { aboveHeight: 100, front: 20, side: 10, rear: 20 },
|
|
36
|
+
* ],
|
|
37
|
+
* verticalCap: { kind: "max_height", maxHeight: 150 },
|
|
38
|
+
* floorToFloor: 12,
|
|
39
|
+
* })
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
abstract create(args: PluginBuildableEnvelopeCreateArgs): PluginApiReturn<PluginBuildableEnvelopeCreateResult>;
|
|
43
|
+
/**
|
|
44
|
+
* Update an existing parametric buildable envelope.
|
|
45
|
+
*
|
|
46
|
+
* @param args - A {@linkcode PluginBuildableEnvelopeUpdateArgs} object.
|
|
47
|
+
* `buildableEnvelopeId` is required and must match an existing envelope on
|
|
48
|
+
* the canvas.
|
|
49
|
+
* @returns A {@linkcode PluginBuildableEnvelopeUpdateResult} with the
|
|
50
|
+
* `buildableEnvelopeId` of the updated envelope.
|
|
51
|
+
* @throws If validation fails, the envelope does not exist, or generation
|
|
52
|
+
* produces no renderable geometry.
|
|
53
|
+
*
|
|
54
|
+
* # Example
|
|
55
|
+
* ```ts
|
|
56
|
+
* const { buildableEnvelopeId } = await snaptrude.entity.buildableEnvelope.update({
|
|
57
|
+
* buildableEnvelopeId: existingId,
|
|
58
|
+
* sitePolygon: [
|
|
59
|
+
* { x: 0, z: 0 },
|
|
60
|
+
* { x: 100, z: 0 },
|
|
61
|
+
* { x: 100, z: 80 },
|
|
62
|
+
* { x: 0, z: 80 },
|
|
63
|
+
* ],
|
|
64
|
+
* lengthUnit: "ft",
|
|
65
|
+
* setbacks: [{ aboveHeight: 0, front: 10, side: 5, rear: 10 }],
|
|
66
|
+
* verticalCap: { kind: "max_height", maxHeight: 175 },
|
|
67
|
+
* floorToFloor: 12,
|
|
68
|
+
* })
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
abstract update(args: PluginBuildableEnvelopeUpdateArgs): PluginApiReturn<PluginBuildableEnvelopeUpdateResult>;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Site polygon vertex in the request `lengthUnit`.
|
|
75
|
+
*
|
|
76
|
+
* Vertices may be passed as `{x, z}` objects or `[x, z]` tuples. Numeric
|
|
77
|
+
* values must be finite (no `NaN` or `±Infinity`).
|
|
78
|
+
*/
|
|
79
|
+
export declare const PluginBuildableEnvelopePolygonVertex: z.ZodUnion<readonly [z.ZodObject<{
|
|
80
|
+
x: z.ZodNumber;
|
|
81
|
+
z: z.ZodNumber;
|
|
82
|
+
}, z.core.$strict>, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>;
|
|
83
|
+
export type PluginBuildableEnvelopePolygonVertex = z.infer<typeof PluginBuildableEnvelopePolygonVertex>;
|
|
84
|
+
/**
|
|
85
|
+
* Vertical cap for a buildable envelope.
|
|
86
|
+
*
|
|
87
|
+
* Use exactly one shape:
|
|
88
|
+
* - `{ kind: "max_height", maxHeight }`
|
|
89
|
+
* - `{ kind: "max_floors", maxFloors }`
|
|
90
|
+
*
|
|
91
|
+
* Floor-to-floor height is not nested here; it is always supplied as the
|
|
92
|
+
* top-level `floorToFloor` argument.
|
|
93
|
+
*/
|
|
94
|
+
export declare const PluginBuildableEnvelopeVerticalCap: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
95
|
+
kind: z.ZodLiteral<"max_height">;
|
|
96
|
+
maxHeight: z.ZodNumber;
|
|
97
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
98
|
+
kind: z.ZodLiteral<"max_floors">;
|
|
99
|
+
maxFloors: z.ZodNumber;
|
|
100
|
+
}, z.core.$strict>], "kind">;
|
|
101
|
+
export type PluginBuildableEnvelopeVerticalCap = z.infer<typeof PluginBuildableEnvelopeVerticalCap>;
|
|
102
|
+
/**
|
|
103
|
+
* One tier of a buildable envelope's setback profile.
|
|
104
|
+
*
|
|
105
|
+
* Tiers are ordered by `aboveHeight`. The first tier (index 0) must have
|
|
106
|
+
* `aboveHeight: 0` and describes the ground footprint; each subsequent tier
|
|
107
|
+
* describes the complete setback at a strictly greater height. Each tier
|
|
108
|
+
* carries its own `front`, `side`, and `rear` values — there is no
|
|
109
|
+
* inheritance from earlier tiers.
|
|
110
|
+
*
|
|
111
|
+
* All numeric values must be finite and nonnegative, in the request
|
|
112
|
+
* `lengthUnit`.
|
|
113
|
+
*
|
|
114
|
+
* | Property | Type | Description |
|
|
115
|
+
* |---|---|---|
|
|
116
|
+
* | `aboveHeight` | `number` | Height at or above which this tier applies; the ground tier uses `0` |
|
|
117
|
+
* | `front` | `number` | Front setback for this tier |
|
|
118
|
+
* | `side` | `number` | Side setback for this tier |
|
|
119
|
+
* | `rear` | `number` | Rear setback for this tier |
|
|
120
|
+
*/
|
|
121
|
+
export declare const PluginBuildableEnvelopeSetbackTier: z.ZodObject<{
|
|
122
|
+
aboveHeight: z.ZodNumber;
|
|
123
|
+
front: z.ZodNumber;
|
|
124
|
+
side: z.ZodNumber;
|
|
125
|
+
rear: z.ZodNumber;
|
|
126
|
+
}, z.core.$strict>;
|
|
127
|
+
export type PluginBuildableEnvelopeSetbackTier = z.infer<typeof PluginBuildableEnvelopeSetbackTier>;
|
|
128
|
+
/**
|
|
129
|
+
* Arguments for {@linkcode PluginBuildableEnvelopeApi.create}.
|
|
130
|
+
*
|
|
131
|
+
* Strict schema. The host owns identity — no `buildableEnvelopeId` is accepted
|
|
132
|
+
* on create; the id is minted by the host and returned in
|
|
133
|
+
* {@linkcode PluginBuildableEnvelopeCreateResult}.
|
|
134
|
+
*
|
|
135
|
+
* | Property | Type | Description |
|
|
136
|
+
* |---|---|---|
|
|
137
|
+
* | `sitePolygon` | {@linkcode PluginBuildableEnvelopePolygonVertex}`[]` | Site polygon vertices in `lengthUnit`; minimum 3 vertices |
|
|
138
|
+
* | `lengthUnit` | `"ft" \| "m"` | Unit used by all length fields |
|
|
139
|
+
* | `setbacks` | {@linkcode PluginBuildableEnvelopeSetbackTier}`[]` | Setback profile, ground tier first; minimum 1 tier |
|
|
140
|
+
* | `verticalCap` | {@linkcode PluginBuildableEnvelopeVerticalCap} | Maximum height or floor count |
|
|
141
|
+
* | `floorToFloor` | `number` | Required floor-to-floor height in `lengthUnit` |
|
|
142
|
+
* | `farRatio` | `number?` | Optional FAR value, positive when provided |
|
|
143
|
+
* | `lotCoverageMaxPct` | `number?` | Optional lot coverage cap, `0..100` |
|
|
144
|
+
*/
|
|
145
|
+
export declare const PluginBuildableEnvelopeCreateArgs: z.ZodObject<{
|
|
146
|
+
sitePolygon: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
147
|
+
x: z.ZodNumber;
|
|
148
|
+
z: z.ZodNumber;
|
|
149
|
+
}, z.core.$strict>, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>>;
|
|
150
|
+
lengthUnit: z.ZodUnion<readonly [z.ZodLiteral<"ft">, z.ZodLiteral<"m">]>;
|
|
151
|
+
setbacks: z.ZodArray<z.ZodObject<{
|
|
152
|
+
aboveHeight: z.ZodNumber;
|
|
153
|
+
front: z.ZodNumber;
|
|
154
|
+
side: z.ZodNumber;
|
|
155
|
+
rear: z.ZodNumber;
|
|
156
|
+
}, z.core.$strict>>;
|
|
157
|
+
verticalCap: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
158
|
+
kind: z.ZodLiteral<"max_height">;
|
|
159
|
+
maxHeight: z.ZodNumber;
|
|
160
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
161
|
+
kind: z.ZodLiteral<"max_floors">;
|
|
162
|
+
maxFloors: z.ZodNumber;
|
|
163
|
+
}, z.core.$strict>], "kind">;
|
|
164
|
+
floorToFloor: z.ZodNumber;
|
|
165
|
+
farRatio: z.ZodOptional<z.ZodNumber>;
|
|
166
|
+
lotCoverageMaxPct: z.ZodOptional<z.ZodNumber>;
|
|
167
|
+
}, z.core.$strict>;
|
|
168
|
+
export type PluginBuildableEnvelopeCreateArgs = z.infer<typeof PluginBuildableEnvelopeCreateArgs>;
|
|
169
|
+
/**
|
|
170
|
+
* Result of {@linkcode PluginBuildableEnvelopeApi.create}.
|
|
171
|
+
*
|
|
172
|
+
* | Property | Type | Description |
|
|
173
|
+
* |---|---|---|
|
|
174
|
+
* | `buildableEnvelopeId` | `string` | Non-empty unique ID of the created buildable envelope |
|
|
175
|
+
*/
|
|
176
|
+
export declare const PluginBuildableEnvelopeCreateResult: z.ZodObject<{
|
|
177
|
+
buildableEnvelopeId: z.ZodString;
|
|
178
|
+
}, z.core.$strict>;
|
|
179
|
+
export type PluginBuildableEnvelopeCreateResult = z.infer<typeof PluginBuildableEnvelopeCreateResult>;
|
|
180
|
+
/**
|
|
181
|
+
* Arguments for {@linkcode PluginBuildableEnvelopeApi.update}.
|
|
182
|
+
*
|
|
183
|
+
* Strict schema. `buildableEnvelopeId` is required and identifies the prior
|
|
184
|
+
* envelope on the canvas to update.
|
|
185
|
+
*
|
|
186
|
+
* | Property | Type | Description |
|
|
187
|
+
* |---|---|---|
|
|
188
|
+
* | `buildableEnvelopeId` | `string` | Existing envelope ID to update; non-empty |
|
|
189
|
+
* | `sitePolygon` | {@linkcode PluginBuildableEnvelopePolygonVertex}`[]` | Site polygon vertices in `lengthUnit`; minimum 3 vertices |
|
|
190
|
+
* | `lengthUnit` | `"ft" \| "m"` | Unit used by all length fields |
|
|
191
|
+
* | `setbacks` | {@linkcode PluginBuildableEnvelopeSetbackTier}`[]` | Setback profile, ground tier first; minimum 1 tier |
|
|
192
|
+
* | `verticalCap` | {@linkcode PluginBuildableEnvelopeVerticalCap} | Maximum height or floor count |
|
|
193
|
+
* | `floorToFloor` | `number` | Required floor-to-floor height in `lengthUnit` |
|
|
194
|
+
* | `farRatio` | `number?` | Optional FAR value, positive when provided |
|
|
195
|
+
* | `lotCoverageMaxPct` | `number?` | Optional lot coverage cap, `0..100` |
|
|
196
|
+
*/
|
|
197
|
+
export declare const PluginBuildableEnvelopeUpdateArgs: z.ZodObject<{
|
|
198
|
+
buildableEnvelopeId: z.ZodString;
|
|
199
|
+
sitePolygon: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
200
|
+
x: z.ZodNumber;
|
|
201
|
+
z: z.ZodNumber;
|
|
202
|
+
}, z.core.$strict>, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>>;
|
|
203
|
+
lengthUnit: z.ZodUnion<readonly [z.ZodLiteral<"ft">, z.ZodLiteral<"m">]>;
|
|
204
|
+
setbacks: z.ZodArray<z.ZodObject<{
|
|
205
|
+
aboveHeight: z.ZodNumber;
|
|
206
|
+
front: z.ZodNumber;
|
|
207
|
+
side: z.ZodNumber;
|
|
208
|
+
rear: z.ZodNumber;
|
|
209
|
+
}, z.core.$strict>>;
|
|
210
|
+
verticalCap: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
211
|
+
kind: z.ZodLiteral<"max_height">;
|
|
212
|
+
maxHeight: z.ZodNumber;
|
|
213
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
214
|
+
kind: z.ZodLiteral<"max_floors">;
|
|
215
|
+
maxFloors: z.ZodNumber;
|
|
216
|
+
}, z.core.$strict>], "kind">;
|
|
217
|
+
floorToFloor: z.ZodNumber;
|
|
218
|
+
farRatio: z.ZodOptional<z.ZodNumber>;
|
|
219
|
+
lotCoverageMaxPct: z.ZodOptional<z.ZodNumber>;
|
|
220
|
+
}, z.core.$strict>;
|
|
221
|
+
export type PluginBuildableEnvelopeUpdateArgs = z.infer<typeof PluginBuildableEnvelopeUpdateArgs>;
|
|
222
|
+
/**
|
|
223
|
+
* Result of {@linkcode PluginBuildableEnvelopeApi.update}.
|
|
224
|
+
*
|
|
225
|
+
* | Property | Type | Description |
|
|
226
|
+
* |---|---|---|
|
|
227
|
+
* | `buildableEnvelopeId` | `string` | Non-empty unique ID of the updated buildable envelope |
|
|
228
|
+
*/
|
|
229
|
+
export declare const PluginBuildableEnvelopeUpdateResult: z.ZodObject<{
|
|
230
|
+
buildableEnvelopeId: z.ZodString;
|
|
231
|
+
}, z.core.$strict>;
|
|
232
|
+
export type PluginBuildableEnvelopeUpdateResult = z.infer<typeof PluginBuildableEnvelopeUpdateResult>;
|
|
233
|
+
//# sourceMappingURL=buildableEnvelope.d.ts.map
|
|
@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,IAAI,EAAE,iCAAiC,GACtC,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,MAAM,CACpB,IAAI,EAAE,iCAAiC,GACtC,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"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { PluginBuildableEnvelopeApi } from "./buildableEnvelope";
|
|
1
2
|
import { PluginDepartmentApi } from "./department";
|
|
2
3
|
import { PluginReferenceLineApi } from "./referenceLine";
|
|
3
4
|
import { PluginSpaceApi } from "./space";
|
|
@@ -9,6 +10,7 @@ import { PluginStoryApi } from "./story";
|
|
|
9
10
|
* - {@linkcode PluginEntityApi.story} — Create, query, and update stories (floors)
|
|
10
11
|
* - {@linkcode PluginEntityApi.referenceLine} — Create, query, and delete reference lines
|
|
11
12
|
* - {@linkcode PluginEntityApi.department} — Create and query departments
|
|
13
|
+
* - {@linkcode PluginEntityApi.buildableEnvelope} — Create or update parametric buildable envelopes
|
|
12
14
|
*/
|
|
13
15
|
export declare abstract class PluginEntityApi {
|
|
14
16
|
/** Space (room/mass) operations. See {@linkcode PluginSpaceApi}. */
|
|
@@ -19,8 +21,11 @@ export declare abstract class PluginEntityApi {
|
|
|
19
21
|
abstract referenceLine: PluginReferenceLineApi;
|
|
20
22
|
/** Department operations. See {@linkcode PluginDepartmentApi}. */
|
|
21
23
|
abstract department: PluginDepartmentApi;
|
|
24
|
+
/** Buildable Envelope operations. See {@linkcode PluginBuildableEnvelopeApi}. */
|
|
25
|
+
abstract buildableEnvelope: PluginBuildableEnvelopeApi;
|
|
22
26
|
constructor();
|
|
23
27
|
}
|
|
28
|
+
export * from "./buildableEnvelope";
|
|
24
29
|
export * from "./department";
|
|
25
30
|
export * from "./referenceLine";
|
|
26
31
|
export * from "./space";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/entity/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/entity/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;;;GAQG;AACH,8BAAsB,eAAe;IACnC,oEAAoE;IACpE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,uEAAuE;IACvE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,yEAAyE;IACzE,SAAgB,aAAa,EAAE,sBAAsB,CAAA;IACrD,kEAAkE;IAClE,SAAgB,UAAU,EAAE,mBAAmB,CAAA;IAC/C,iFAAiF;IACjF,SAAgB,iBAAiB,EAAE,0BAA0B,CAAA;;CAG9D;AAED,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
|
|
@@ -424,6 +424,7 @@ export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<typeof PluginSp
|
|
|
424
424
|
* | `"profile"` | {@linkcode PProfile} | Bottom outer profile in world space, preserving line/arc curve data. |
|
|
425
425
|
*/
|
|
426
426
|
export declare const PluginSpaceGetProperty: z.ZodEnum<{
|
|
427
|
+
type: "type";
|
|
427
428
|
name: "name";
|
|
428
429
|
departmentId: "departmentId";
|
|
429
430
|
id: "id";
|
|
@@ -431,7 +432,6 @@ export declare const PluginSpaceGetProperty: z.ZodEnum<{
|
|
|
431
432
|
position: "position";
|
|
432
433
|
height: "height";
|
|
433
434
|
depth: "depth";
|
|
434
|
-
type: "type";
|
|
435
435
|
room_type: "room_type";
|
|
436
436
|
area: "area";
|
|
437
437
|
breadth: "breadth";
|
|
@@ -456,6 +456,7 @@ export declare const PluginSpaceGetProperty: z.ZodEnum<{
|
|
|
456
456
|
export declare const PluginSpaceGetArgs: z.ZodObject<{
|
|
457
457
|
spaceId: z.ZodString;
|
|
458
458
|
properties: z.ZodArray<z.ZodEnum<{
|
|
459
|
+
type: "type";
|
|
459
460
|
name: "name";
|
|
460
461
|
departmentId: "departmentId";
|
|
461
462
|
id: "id";
|
|
@@ -463,7 +464,6 @@ export declare const PluginSpaceGetArgs: z.ZodObject<{
|
|
|
463
464
|
position: "position";
|
|
464
465
|
height: "height";
|
|
465
466
|
depth: "depth";
|
|
466
|
-
type: "type";
|
|
467
467
|
room_type: "room_type";
|
|
468
468
|
area: "area";
|
|
469
469
|
breadth: "breadth";
|
|
@@ -121,10 +121,10 @@ export declare abstract class PluginStoryApi {
|
|
|
121
121
|
* | `"totalArea"` | `number` | Total floor area of this story |
|
|
122
122
|
*/
|
|
123
123
|
export declare const PluginStoryGetProperty: z.ZodEnum<{
|
|
124
|
+
value: "value";
|
|
124
125
|
name: "name";
|
|
125
126
|
id: "id";
|
|
126
127
|
height: "height";
|
|
127
|
-
value: "value";
|
|
128
128
|
base: "base";
|
|
129
129
|
hidden: "hidden";
|
|
130
130
|
spacesCount: "spacesCount";
|
|
@@ -141,10 +141,10 @@ export declare const PluginStoryGetProperty: z.ZodEnum<{
|
|
|
141
141
|
export declare const PluginStoryGetArgs: z.ZodObject<{
|
|
142
142
|
storyValue: z.ZodNumber;
|
|
143
143
|
properties: z.ZodArray<z.ZodEnum<{
|
|
144
|
+
value: "value";
|
|
144
145
|
name: "name";
|
|
145
146
|
id: "id";
|
|
146
147
|
height: "height";
|
|
147
|
-
value: "value";
|
|
148
148
|
base: "base";
|
|
149
149
|
hidden: "hidden";
|
|
150
150
|
spacesCount: "spacesCount";
|