@snaptrude/plugin-core 0.6.0 → 0.7.0

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.
Files changed (83) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/api-manifest.full.json +511 -10
  3. package/api-manifest.json +529 -4
  4. package/dist/api/core/index.d.ts +5 -0
  5. package/dist/api/core/index.d.ts.map +1 -1
  6. package/dist/api/core/proposals/index.d.ts +475 -0
  7. package/dist/api/core/proposals/index.d.ts.map +1 -0
  8. package/dist/api/design/create/index.d.ts +209 -0
  9. package/dist/api/design/create/index.d.ts.map +1 -1
  10. package/dist/api/design/doors/index.d.ts +159 -0
  11. package/dist/api/design/doors/index.d.ts.map +1 -1
  12. package/dist/api/design/furniture/index.d.ts +34 -5
  13. package/dist/api/design/furniture/index.d.ts.map +1 -1
  14. package/dist/api/design/index.d.ts +83 -0
  15. package/dist/api/design/index.d.ts.map +1 -1
  16. package/dist/api/design/lock.d.ts +26 -0
  17. package/dist/api/design/lock.d.ts.map +1 -1
  18. package/dist/api/design/materials/index.d.ts +159 -2
  19. package/dist/api/design/materials/index.d.ts.map +1 -1
  20. package/dist/api/design/query/index.d.ts +115 -5
  21. package/dist/api/design/query/index.d.ts.map +1 -1
  22. package/dist/api/design/selection/index.d.ts +2 -2
  23. package/dist/api/design/transform/index.d.ts +83 -2
  24. package/dist/api/design/transform/index.d.ts.map +1 -1
  25. package/dist/api/design/update/index.d.ts +168 -0
  26. package/dist/api/design/update/index.d.ts.map +1 -1
  27. package/dist/api/design/windows/index.d.ts +113 -2
  28. package/dist/api/design/windows/index.d.ts.map +1 -1
  29. package/dist/api/entity/story.d.ts +101 -7
  30. package/dist/api/entity/story.d.ts.map +1 -1
  31. package/dist/api/presentation/import.d.ts +49 -4
  32. package/dist/api/presentation/import.d.ts.map +1 -1
  33. package/dist/api/presentation/views.d.ts +210 -5
  34. package/dist/api/presentation/views.d.ts.map +1 -1
  35. package/dist/api/program/areas.d.ts +42 -12
  36. package/dist/api/program/areas.d.ts.map +1 -1
  37. package/dist/api/program/index.d.ts +3 -11
  38. package/dist/api/program/index.d.ts.map +1 -1
  39. package/dist/api/program/layout.d.ts +186 -11
  40. package/dist/api/program/layout.d.ts.map +1 -1
  41. package/dist/errors/codes.d.ts +34 -0
  42. package/dist/errors/codes.d.ts.map +1 -0
  43. package/dist/errors/envelope.d.ts +56 -0
  44. package/dist/errors/envelope.d.ts.map +1 -0
  45. package/dist/errors/index.d.ts +6 -0
  46. package/dist/errors/index.d.ts.map +1 -0
  47. package/dist/errors/plugin-error.d.ts +69 -0
  48. package/dist/errors/plugin-error.d.ts.map +1 -0
  49. package/dist/host-utils.d.ts +4 -0
  50. package/dist/host-utils.d.ts.map +1 -1
  51. package/dist/index.cjs +1624 -1028
  52. package/dist/index.cjs.map +1 -1
  53. package/dist/index.d.ts +1 -0
  54. package/dist/index.d.ts.map +1 -1
  55. package/dist/index.js +1546 -1025
  56. package/dist/index.js.map +1 -1
  57. package/package.json +2 -1
  58. package/scripts/generate-manifest.test.mjs +77 -0
  59. package/src/api/core/index.ts +5 -0
  60. package/src/api/core/proposals/index.ts +509 -0
  61. package/src/api/design/create/index.ts +249 -0
  62. package/src/api/design/doors/index.ts +168 -0
  63. package/src/api/design/furniture/index.ts +36 -5
  64. package/src/api/design/index.ts +87 -0
  65. package/src/api/design/lock.ts +27 -0
  66. package/src/api/design/materials/index.ts +182 -2
  67. package/src/api/design/query/index.ts +81 -0
  68. package/src/api/design/transform/index.ts +74 -2
  69. package/src/api/design/update/index.ts +167 -0
  70. package/src/api/design/windows/index.ts +128 -2
  71. package/src/api/entity/story.ts +105 -7
  72. package/src/api/presentation/import.ts +45 -4
  73. package/src/api/presentation/views.ts +221 -5
  74. package/src/api/program/areas.ts +34 -12
  75. package/src/api/program/index.ts +3 -11
  76. package/src/api/program/layout.ts +195 -11
  77. package/src/errors/codes.ts +136 -0
  78. package/src/errors/envelope.ts +75 -0
  79. package/src/errors/index.ts +21 -0
  80. package/src/errors/plugin-error.ts +134 -0
  81. package/src/host-utils.ts +4 -0
  82. package/src/index.ts +1 -0
  83. package/test/errors.test.mjs +184 -0
@@ -5,12 +5,12 @@ import { PluginApiReturn } from "../../types";
5
5
  *
6
6
  * A **view** is a saved camera/plan: a sheet-ready 2D plan or a saved 3D view.
7
7
  * A plugin can list and read views, capture them to images, activate one (move
8
- * the camera to it), and save the current camera as a new view.
8
+ * the camera to it), save the current camera as a new view, and read/update a
9
+ * view's display settings (background, color mode, axis, edges, labels).
9
10
  *
10
- * `list`/`get`/`getActive`/`capture` are reads; `setActive`/`create` are writes
11
- * (a view is a camera bookmark — not geometry). Members typed optional (`?`) are
12
- * authored ahead of the host: declared for plugins/codegen but not yet on the
13
- * live discovery surface until the host lands them.
11
+ * `list`/`get`/`getActive`/`capture`/`getSettings` are reads;
12
+ * `setActive`/`create`/`updateSettings` are writes (a view is a camera bookmark
13
+ * not geometry).
14
14
  *
15
15
  * Accessed via `snaptrude.presentation.views`.
16
16
  */
@@ -141,6 +141,78 @@ export declare abstract class PluginPresentationViewsApi {
141
141
  abstract create(name?: string, options?: {
142
142
  kind?: "view" | "sitePlan";
143
143
  }): PluginApiReturn<PluginPresentationViewsCreateResult>;
144
+ /**
145
+ * Read a saved view's display settings (background, color mode, axis, edges,
146
+ * labels).
147
+ *
148
+ * @param viewId - The id of the view to read settings for.
149
+ * @returns The view's {@linkcode PluginPresentationViewSettings}, or `null` if
150
+ * no view has that id.
151
+ *
152
+ * @examplePrompt What color mode is the Ground Floor view using?
153
+ * @examplePrompt Get the display settings for this view
154
+ * @examplePrompt Does the site plan view show axes and labels?
155
+ * @examplePrompt Read the background color of the active view
156
+ *
157
+ * # Example
158
+ * ```ts
159
+ * const settings = await snaptrude.presentation.views.getSettings("view_123")
160
+ * if (settings) console.log(settings.colorMode, settings.backgroundColor)
161
+ * ```
162
+ */
163
+ abstract getSettings(viewId: string): PluginApiReturn<PluginPresentationViewsGetSettingsResult>;
164
+ /**
165
+ * Update a saved view's display settings (partial patch — only the fields you
166
+ * pass change).
167
+ *
168
+ * Persists and broadcasts the change; if the view is currently active, the
169
+ * scene updates live. **Not Ctrl+Z-undoable** — view-metadata edits publish
170
+ * directly and do not land on the local undo stack; this matches how the
171
+ * product's own view-settings UI behaves.
172
+ *
173
+ * Label patch semantics (mirroring the product, which stores no label
174
+ * selection while labels are off):
175
+ *
176
+ * - `{ showLabels: true }` alone turns labels on; if the view has no stored
177
+ * selection, the product defaults (`objectLabels`, `areas`) are applied —
178
+ * labels are never "on" with an empty selection (the product has no such
179
+ * state; labels render only while the selection is non-empty).
180
+ * - `{ labels: [...] }` alone sets the selection **and turns labels on**.
181
+ * - `{ showLabels: false }` turns labels off and **clears the stored
182
+ * selection** — a later read returns `labels: []`.
183
+ * - `{ showLabels: false, labels: [...] }` with a non-empty list is
184
+ * contradictory and **rejected** (nothing is silently discarded).
185
+ * - `{ showLabels: true, labels: [] }` is likewise contradictory and
186
+ * **rejected** — pass a non-empty list, or omit `labels` to get the
187
+ * defaults.
188
+ *
189
+ * `colorMode` accepts the `tag:<categoryId>` scheme strings returned by
190
+ * {@linkcode PluginPresentationViewsApi.getSettings}, so read-then-write
191
+ * round-trips a tag-based color scheme unchanged.
192
+ *
193
+ * @param viewId - The id of the view to update.
194
+ * @param settings - A partial {@linkcode PluginPresentationViewSettings}; any
195
+ * omitted field is left unchanged.
196
+ * @returns The updated view's `id`.
197
+ * @throws If writes are disabled, no view has the given id, or the patch is
198
+ * contradictory (`showLabels: false` with a non-empty `labels`, or
199
+ * `showLabels: true` with an explicitly empty `labels` list).
200
+ *
201
+ * @examplePrompt Switch this view to monochrome color mode
202
+ * @examplePrompt Turn off the axis in the Ground Floor view
203
+ * @examplePrompt Set the background of the active view to white
204
+ * @examplePrompt Show area labels on this view
205
+ * @examplePrompt Enable hidden-line mode for the section view
206
+ *
207
+ * # Example
208
+ * ```ts
209
+ * await snaptrude.presentation.views.updateSettings("view_123", {
210
+ * colorMode: "monochrome",
211
+ * showAxis: false,
212
+ * })
213
+ * ```
214
+ */
215
+ abstract updateSettings(viewId: string, settings: Partial<PluginPresentationViewSettings>): PluginApiReturn<PluginPresentationViewsUpdateSettingsResult>;
144
216
  }
145
217
  /**
146
218
  * The kind of a saved view: a 2D plan view or a 3D view.
@@ -293,4 +365,137 @@ export declare const PluginPresentationViewsCreateResult: z.ZodObject<{
293
365
  isActive: z.ZodBoolean;
294
366
  }, z.core.$strip>;
295
367
  export type PluginPresentationViewsCreateResult = z.infer<typeof PluginPresentationViewsCreateResult>;
368
+ /**
369
+ * How the scene is colored in a view.
370
+ *
371
+ * | Value | Meaning |
372
+ * |---|---|
373
+ * | `monochrome` | Flat single-tone shading |
374
+ * | `texture` | Material textures/colors |
375
+ * | `department` | Colored by department |
376
+ * | `tag:<categoryId>` | Colored by a project tag category (e.g. `tag:ZONE`) |
377
+ *
378
+ * The `tag:<categoryId>` form carries the product's tag-based color schemes
379
+ * losslessly — reading a view that uses one returns the `tag:` string as-is,
380
+ * and writing it back preserves the scheme (read-then-write is safe).
381
+ */
382
+ export declare const PluginPresentationViewColorMode: z.ZodUnion<readonly [z.ZodEnum<{
383
+ department: "department";
384
+ monochrome: "monochrome";
385
+ texture: "texture";
386
+ }>, z.ZodTemplateLiteral<`tag:${string}`>]>;
387
+ export type PluginPresentationViewColorMode = z.infer<typeof PluginPresentationViewColorMode>;
388
+ /**
389
+ * A category of on-canvas labels a view can show.
390
+ *
391
+ * | Value | Meaning |
392
+ * |---|---|
393
+ * | `objectLabels` | Per-object name labels |
394
+ * | `areas` | Area/room labels |
395
+ * | `department` | Department labels |
396
+ */
397
+ export declare const PluginPresentationViewLabel: z.ZodEnum<{
398
+ department: "department";
399
+ objectLabels: "objectLabels";
400
+ areas: "areas";
401
+ }>;
402
+ export type PluginPresentationViewLabel = z.infer<typeof PluginPresentationViewLabel>;
403
+ /**
404
+ * A view's display settings.
405
+ *
406
+ * | Property | Type | Description |
407
+ * |---|---|---|
408
+ * | `backgroundColor` | `string` | Canvas background as a hex color (e.g. `#ffffff`) |
409
+ * | `colorMode` | {@linkcode PluginPresentationViewColorMode} | How the scene is colored (including `tag:<categoryId>` schemes) |
410
+ * | `showAxis` | `boolean` | Whether the X/Y/Z axes are shown |
411
+ * | `showEdges` | `boolean` | Whether edges are shown; `false` = hidden-line rendering |
412
+ * | `showLabels` | `boolean` | Master label switch — whether on-canvas labels are shown at all. `true` always pairs with a non-empty `labels` selection (labels render only while the selection is non-empty; there is no labels-on-with-empty-selection state) |
413
+ * | `labels` | {@linkcode PluginPresentationViewLabel}`[]` | Which label categories are selected. When `showLabels` is `false` the view stores no selection and this reads `[]` |
414
+ */
415
+ export declare const PluginPresentationViewSettings: z.ZodObject<{
416
+ backgroundColor: z.ZodString;
417
+ colorMode: z.ZodUnion<readonly [z.ZodEnum<{
418
+ department: "department";
419
+ monochrome: "monochrome";
420
+ texture: "texture";
421
+ }>, z.ZodTemplateLiteral<`tag:${string}`>]>;
422
+ showAxis: z.ZodBoolean;
423
+ showEdges: z.ZodBoolean;
424
+ showLabels: z.ZodBoolean;
425
+ labels: z.ZodArray<z.ZodEnum<{
426
+ department: "department";
427
+ objectLabels: "objectLabels";
428
+ areas: "areas";
429
+ }>>;
430
+ }, z.core.$strip>;
431
+ export type PluginPresentationViewSettings = z.infer<typeof PluginPresentationViewSettings>;
432
+ /**
433
+ * Arguments for {@linkcode PluginPresentationViewsApi.getSettings}.
434
+ *
435
+ * | Property | Type | Description |
436
+ * |---|---|---|
437
+ * | `id` | `string` | The id of the view to read settings for |
438
+ */
439
+ export declare const PluginPresentationViewsGetSettingsArgs: z.ZodObject<{
440
+ id: z.ZodString;
441
+ }, z.core.$strip>;
442
+ export type PluginPresentationViewsGetSettingsArgs = z.infer<typeof PluginPresentationViewsGetSettingsArgs>;
443
+ /**
444
+ * Result of {@linkcode PluginPresentationViewsApi.getSettings} — the settings,
445
+ * or `null` when no view has that id.
446
+ */
447
+ export declare const PluginPresentationViewsGetSettingsResult: z.ZodNullable<z.ZodObject<{
448
+ backgroundColor: z.ZodString;
449
+ colorMode: z.ZodUnion<readonly [z.ZodEnum<{
450
+ department: "department";
451
+ monochrome: "monochrome";
452
+ texture: "texture";
453
+ }>, z.ZodTemplateLiteral<`tag:${string}`>]>;
454
+ showAxis: z.ZodBoolean;
455
+ showEdges: z.ZodBoolean;
456
+ showLabels: z.ZodBoolean;
457
+ labels: z.ZodArray<z.ZodEnum<{
458
+ department: "department";
459
+ objectLabels: "objectLabels";
460
+ areas: "areas";
461
+ }>>;
462
+ }, z.core.$strip>>;
463
+ export type PluginPresentationViewsGetSettingsResult = z.infer<typeof PluginPresentationViewsGetSettingsResult>;
464
+ /**
465
+ * Arguments for {@linkcode PluginPresentationViewsApi.updateSettings}. The
466
+ * `settings` patch is partial — any omitted field is left unchanged. A patch
467
+ * pairing `showLabels: false` with a non-empty `labels` list, or
468
+ * `showLabels: true` with an explicitly empty `labels` list, is rejected as
469
+ * contradictory (see the method JSDoc for the full label patch semantics).
470
+ *
471
+ * | Property | Type | Description |
472
+ * |---|---|---|
473
+ * | `id` | `string` | The id of the view to update |
474
+ * | `settings` | `Partial<`{@linkcode PluginPresentationViewSettings}`>` | The fields to change |
475
+ */
476
+ export declare const PluginPresentationViewsUpdateSettingsArgs: z.ZodObject<{
477
+ id: z.ZodString;
478
+ settings: z.ZodObject<{
479
+ backgroundColor: z.ZodOptional<z.ZodString>;
480
+ colorMode: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
481
+ department: "department";
482
+ monochrome: "monochrome";
483
+ texture: "texture";
484
+ }>, z.ZodTemplateLiteral<`tag:${string}`>]>>;
485
+ showAxis: z.ZodOptional<z.ZodBoolean>;
486
+ showEdges: z.ZodOptional<z.ZodBoolean>;
487
+ showLabels: z.ZodOptional<z.ZodBoolean>;
488
+ labels: z.ZodOptional<z.ZodArray<z.ZodEnum<{
489
+ department: "department";
490
+ objectLabels: "objectLabels";
491
+ areas: "areas";
492
+ }>>>;
493
+ }, z.core.$strip>;
494
+ }, z.core.$strip>;
495
+ export type PluginPresentationViewsUpdateSettingsArgs = z.infer<typeof PluginPresentationViewsUpdateSettingsArgs>;
496
+ /** Result of {@linkcode PluginPresentationViewsApi.updateSettings} — the updated view's id. */
497
+ export declare const PluginPresentationViewsUpdateSettingsResult: z.ZodObject<{
498
+ id: z.ZodString;
499
+ }, z.core.$strip>;
500
+ export type PluginPresentationViewsUpdateSettingsResult = z.infer<typeof PluginPresentationViewsUpdateSettingsResult>;
296
501
  //# sourceMappingURL=views.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE1E;;;;;;;;;;;;;;;OAeG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QACvB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,oCAAoC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,GACvC,eAAe,CAAC,mCAAmC,CAAC;CACxD;AAED;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;EAAuB,CAAA;AAC9D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;iBAKjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;kBACV,CAAA;AACnC,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,6BAA6B;;;EAA0B,CAAA;AACpE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,mCAAmC;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA"}
1
+ {"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE1E;;;;;;;;;;;;;;;OAeG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QACvB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,oCAAoC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,GACvC,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wCAAwC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAChD,eAAe,CAAC,2CAA2C,CAAC;CAChE;AAED;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;EAAuB,CAAA;AAC9D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;iBAKjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;kBACV,CAAA;AACnC,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,6BAA6B;;;EAA0B,CAAA;AACpE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,mCAAmC;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,+BAA+B;;;;2CAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;EAItC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAOzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;kBACV,CAAA;AAC3C,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;iBAwBnD,CAAA;AACH,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,2CAA2C;;iBAEtD,CAAA;AACF,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA"}
@@ -10,15 +10,25 @@ import { ComponentHandle } from "../../handles";
10
10
  * department-allocation lens (targets vs allocated area per department); this
11
11
  * namespace is the whole-program area/FAR summary and its groupings.
12
12
  *
13
+ * **Net vs gross:** the `carpet` / `builtUp` / `excluded` figures are the three
14
+ * area *classes* — every space's whole footprint lands in exactly one, chosen
15
+ * by its `areaClass` (see {@linkcode PluginProgramAreaMember.areaClass}). In UI
16
+ * terms `carpet` is the **Net Internal Area** (Σ of `NET`-classed spaces), and
17
+ * `builtUp` is the **Gross External Area** (Σ of `GROSS`-classed spaces) — so
18
+ * "net" and "gross" are the plain-English synonyms for `carpet` and `builtUp`.
19
+ * These are not wall-thickness carpet-vs-super-built-up; there is no common-area
20
+ * math. Note the summary also folds in non-mass elements (floors count as NET,
21
+ * slabs as GROSS), so **summing `listMembers` spaces does not reconcile to the
22
+ * summary totals**.
23
+ *
13
24
  * `achievedFar` is **derived and read-only** — computed from built-up area and
14
25
  * site area. `targetFar` is the goal you set (via {@linkcode
15
26
  * PluginProgramAreasApi.update}); the two are the same ratio, one measured and
16
27
  * one intended. The surface speaks **FAR only** — there is no FSI alias.
17
28
  *
18
- * Reads return plain records and never throw. The write member typed as optional
19
- * (`?`) is **authored ahead of the host** declared so plugins and codegen can
20
- * see the shape, but kept out of the discovery manifest until the host lands it
21
- * (at which point it is promoted to a required `abstract` member).
29
+ * Reads return plain records and never throw. The only write
30
+ * {@linkcode PluginProgramAreasApi.update}is a non-undoable settings write
31
+ * for the FAR inputs.
22
32
  *
23
33
  * Accessed via `snaptrude.program.areas`.
24
34
  */
@@ -35,6 +45,8 @@ export declare abstract class PluginProgramAreasApi {
35
45
  *
36
46
  * @examplePrompt What's my FAR right now?
37
47
  * @examplePrompt Give me the program area summary
48
+ * @examplePrompt What is my net internal area vs gross external area?
49
+ * @examplePrompt How much net and gross area do I have?
38
50
  * @examplePrompt How much built-up area have I used against the site area?
39
51
  * @examplePrompt Am I within my FAR target?
40
52
  *
@@ -58,6 +70,7 @@ export declare abstract class PluginProgramAreasApi {
58
70
  * (empty when the program has no spaces).
59
71
  *
60
72
  * @examplePrompt Break down the area by storey
73
+ * @examplePrompt Break down net vs gross area by storey
61
74
  * @examplePrompt Show the area rollup per department
62
75
  * @examplePrompt Group the built-up area by building
63
76
  *
@@ -84,6 +97,7 @@ export declare abstract class PluginProgramAreasApi {
84
97
  * array (empty when the group is missing or empty).
85
98
  *
86
99
  * @examplePrompt List the spaces on this storey with their areas
100
+ * @examplePrompt Which spaces are net and which are gross on this storey?
87
101
  * @examplePrompt What rooms are in the Bedrooms department bucket?
88
102
  * @examplePrompt Break the storey area down into individual spaces
89
103
  *
@@ -130,9 +144,9 @@ export declare abstract class PluginProgramAreasApi {
130
144
  * |---|---|---|
131
145
  * | `count` | `number` | Number of spaces in the program (a count, not an area) |
132
146
  * | `hiddenCount` | `number` | Number of those spaces that are currently hidden |
133
- * | `carpet` | `number` | Total carpet area in `areaUnit` |
134
- * | `builtUp` | `number` | Total built-up area in `areaUnit` |
135
- * | `excluded` | `number` | Total excluded area in `areaUnit` |
147
+ * | `carpet` | `number` | Total **Net Internal Area** ("net") — Σ `NET`-classed spaces + floors — in `areaUnit` |
148
+ * | `builtUp` | `number` | Total **Gross External Area** ("gross") — Σ `GROSS`-classed spaces + slabs — in `areaUnit` |
149
+ * | `excluded` | `number` | Total **Excluded Area** — Σ `EXCLUDED`-classed spaces — in `areaUnit` |
136
150
  * | `farBuiltUp` | `number` | Built-up area that counts toward FAR, in `areaUnit` |
137
151
  * | `siteArea` | `number` | Site/plot area in `areaUnit` |
138
152
  * | `achievedFar` | `number \| null` | Derived FAR (`farBuiltUp / siteArea`); `null` when site area or target FAR is unset |
@@ -167,8 +181,8 @@ export type PluginProgramAreaSummary = z.infer<typeof PluginProgramAreaSummary>;
167
181
  * | `groupId` | `string` | Stable id of the group (e.g. storey id, department id) |
168
182
  * | `name` | `string` | Display name of the group |
169
183
  * | `color` | `string` | CSS hex color string for the group |
170
- * | `carpet` | `number` | Carpet area for this group |
171
- * | `builtUp` | `number` | Built-up area for this group |
184
+ * | `carpet` | `number` | Net Internal Area ("net") for this group |
185
+ * | `builtUp` | `number` | Gross External Area ("gross") for this group |
172
186
  * | `excluded` | `number` | Excluded area for this group |
173
187
  * | `count` | `number` | Number of spaces in this group |
174
188
  * | `targetArea` | `number` | Target area for this group, in `targetUnit` |
@@ -193,18 +207,29 @@ export type PluginProgramAreaGroup = z.infer<typeof PluginProgramAreaGroup>;
193
207
  * A single space within an area group. Area figures are in the program's area
194
208
  * unit (see {@linkcode PluginProgramAreaSummary.areaUnit}).
195
209
  *
210
+ * `areaClass` is the space's effective classification — it decides which of the
211
+ * three buckets the space's whole footprint lands in: `NET` → `carpet` ("net"),
212
+ * `GROSS` → `builtUp` ("gross"), `EXCLUDED` → `excluded`. So for any one member
213
+ * exactly one of `carpet` / `builtUp` / `excluded` is non-zero.
214
+ *
196
215
  * | Property | Type | Description |
197
216
  * |---|---|---|
198
217
  * | `id` | `ComponentHandle` | `Component.id` of the space (never a mesh handle) |
199
218
  * | `label` | `string` | Display label of the space |
200
- * | `carpet` | `number` | Carpet area of the space |
201
- * | `builtUp` | `number` | Built-up area of the space |
202
- * | `excluded` | `number` | Excluded area of the space |
219
+ * | `areaClass` | {@linkcode PluginAreaClass} | Effective area class `"NET"` (→ `carpet`), `"GROSS"` (→ `builtUp`), or `"EXCLUDED"` |
220
+ * | `carpet` | `number` | Net area of the space (non-zero when `areaClass` is `"NET"`) |
221
+ * | `builtUp` | `number` | Gross area of the space (non-zero when `areaClass` is `"GROSS"`) |
222
+ * | `excluded` | `number` | Excluded area of the space (non-zero when `areaClass` is `"EXCLUDED"`) |
203
223
  * | `isVisible` | `boolean` | Whether the space is currently visible |
204
224
  */
205
225
  export declare const PluginProgramAreaMember: z.ZodObject<{
206
226
  id: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
207
227
  label: z.ZodString;
228
+ areaClass: z.ZodEnum<{
229
+ NET: "NET";
230
+ GROSS: "GROSS";
231
+ EXCLUDED: "EXCLUDED";
232
+ }>;
208
233
  carpet: z.ZodNumber;
209
234
  builtUp: z.ZodNumber;
210
235
  excluded: z.ZodNumber;
@@ -313,6 +338,11 @@ export declare const PluginProgramAreasListMembersResult: z.ZodObject<{
313
338
  members: z.ZodArray<z.ZodObject<{
314
339
  id: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
315
340
  label: z.ZodString;
341
+ areaClass: z.ZodEnum<{
342
+ NET: "NET";
343
+ GROSS: "GROSS";
344
+ EXCLUDED: "EXCLUDED";
345
+ }>;
316
346
  carpet: z.ZodNumber;
317
347
  builtUp: z.ZodNumber;
318
348
  excluded: z.ZodNumber;
@@ -1 +1 @@
1
- {"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;OAmBG;aACa,GAAG,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,IAAI,CAClB,OAAO,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,WAAW,CACzB,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACtE,eAAe,CAAC,8BAA8B,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;iBAYnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB;;;;;;;iBAOlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB;;;;;;EAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kFAAkF;AAClF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACnE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAOnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAQ1C,CAAA;AACJ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACtE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA"}
1
+ {"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,IAAI,CAClB,OAAO,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,WAAW,CACzB,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACtE,eAAe,CAAC,8BAA8B,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;iBAYnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB;;;;;;EAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kFAAkF;AAClF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACnE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAOnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAQ1C,CAAA;AACJ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACtE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA"}
@@ -18,7 +18,7 @@ import { PluginProgramAreasApi } from "./areas";
18
18
  *
19
19
  * - {@linkcode PluginProgramApi.departments} — Read & edit program departments (groupings + targets)
20
20
  * - {@linkcode PluginProgramApi.adjacency} — Read & compute the department/space adjacency matrix
21
- * - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope (authored ahead)
21
+ * - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
22
22
  * - {@linkcode PluginProgramApi.metrics} — Read the area-program summary
23
23
  * - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
24
24
  * - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets and read it back
@@ -26,11 +26,6 @@ import { PluginProgramAreasApi } from "./areas";
26
26
  * - {@linkcode PluginProgramApi.cores} — Read & trigger vertical-circulation cores
27
27
  * - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
28
28
  *
29
- * Sub-namespaces typed as optional (`?`) are **authored ahead of the host** —
30
- * declared so plugins and codegen can see the shape, but not required of host
31
- * implementations and kept out of the discovery manifest until the host lands
32
- * them (at which point they are promoted to required `abstract` members).
33
- *
34
29
  * Accessed via `snaptrude.program`.
35
30
  */
36
31
  export declare abstract class PluginProgramApi {
@@ -38,11 +33,8 @@ export declare abstract class PluginProgramApi {
38
33
  abstract departments: PluginProgramDepartmentsApi;
39
34
  /** Adjacency matrix — read & compute proximity relationships. See {@linkcode PluginProgramAdjacencyApi}. */
40
35
  abstract adjacency: PluginProgramAdjacencyApi;
41
- /**
42
- * Arrange/pack spaces in the envelope. See {@linkcode PluginProgramLayoutApi}.
43
- * _(authored ahead — optional until the host lands it next increment.)_
44
- */
45
- layout?: PluginProgramLayoutApi;
36
+ /** Arrange/pack spaces in the envelope (async job family). See {@linkcode PluginProgramLayoutApi}. */
37
+ abstract layout: PluginProgramLayoutApi;
46
38
  /** Area-program summary — targets vs allocated area. See {@linkcode PluginProgramMetricsApi}. */
47
39
  abstract metrics: PluginProgramMetricsApi;
48
40
  /** FAR / built-up-area rollup and groupings. See {@linkcode PluginProgramAreasApi}. */
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,4GAA4G;IAC5G,SAAgB,SAAS,EAAE,yBAAyB,CAAA;IACpD;;;OAGG;IACI,MAAM,CAAC,EAAE,sBAAsB,CAAA;IACtC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,uBAAuB,CAAA;IAChD,uFAAuF;IACvF,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,2HAA2H;IAC3H,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,mHAAmH;IACnH,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,mIAAmI;IACnI,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,qHAAqH;IACrH,SAAgB,cAAc,EAAE,8BAA8B,CAAA;;CAG/D;AAED,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,4GAA4G;IAC5G,SAAgB,SAAS,EAAE,yBAAyB,CAAA;IACpD,sGAAsG;IACtG,SAAgB,MAAM,EAAE,sBAAsB,CAAA;IAC9C,iGAAiG;IACjG,SAAgB,OAAO,EAAE,uBAAuB,CAAA;IAChD,uFAAuF;IACvF,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,2HAA2H;IAC3H,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,mHAAmH;IACnH,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,mIAAmI;IACnI,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,qHAAqH;IACrH,SAAgB,cAAc,EAAE,8BAA8B,CAAA;;CAG/D;AAED,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}