@snaptrude/plugin-core 0.9.7 → 0.9.9
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 +4 -0
- package/CHANGELOG.md +11 -0
- package/api-manifest.json +222 -4
- package/dist/api/core/tags.d.ts +81 -0
- package/dist/api/core/tags.d.ts.map +1 -1
- package/dist/api/design/create/bulk-items.d.ts +14 -6
- package/dist/api/design/create/bulk-items.d.ts.map +1 -1
- package/dist/api/design/create/index.d.ts +41 -18
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/create/opening-fields.d.ts +10 -2
- package/dist/api/design/create/opening-fields.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +20 -13
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/program/departments.d.ts +58 -2
- package/dist/api/program/departments.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +16 -6
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/labels.d.ts +355 -0
- package/dist/api/program/labels.d.ts.map +1 -0
- package/dist/api/program/metadata.d.ts +328 -0
- package/dist/api/program/metadata.d.ts.map +1 -0
- package/dist/api/program/spreadsheet.d.ts +263 -0
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/index.cjs +1084 -833
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +1039 -833
- package/dist/index.js.map +1 -1
- package/package.json +13 -13
- package/src/api/core/tags.ts +76 -0
- package/src/api/design/create/bulk-items.ts +10 -6
- package/src/api/design/create/index.ts +43 -24
- package/src/api/design/create/opening-fields.ts +10 -2
- package/src/api/design/doors/index.ts +20 -13
- package/src/api/program/departments.ts +54 -2
- package/src/api/program/index.ts +16 -6
- package/src/api/program/labels.ts +332 -0
- package/src/api/program/metadata.ts +364 -0
- package/src/api/program/spreadsheet.ts +282 -0
- package/api-manifest.full.json +0 -8442
|
@@ -643,12 +643,15 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
643
643
|
* @param catalogId - Library id: team `_id` or general `fullName`
|
|
644
644
|
* @param hostWall - The wall to host the door
|
|
645
645
|
* @param position - World point projected onto the wall to locate the opening
|
|
646
|
-
* @param options - Optional placement options: `label` — instance name
|
|
647
|
-
*
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
*
|
|
646
|
+
* @param options - Optional placement options: `label` — instance name;
|
|
647
|
+
* `hinge` — world point near the jamb the door is hinged on (the door is
|
|
648
|
+
* reflected along the wall so its hinged jamb is the one nearer this
|
|
649
|
+
* point; default the catalog item's authored hinge side)
|
|
650
|
+
* @param facing - World point on the side of the wall the door swings open
|
|
651
|
+
* to (the room it opens into — where the plan symbol draws the swing arc).
|
|
652
|
+
* Any point clearly on that side works (e.g. the room's center). Default:
|
|
653
|
+
* the engine picks a side (nondeterministic when `position` sits on the
|
|
654
|
+
* wall centerline).
|
|
652
655
|
* @returns the {@linkcode ComponentHandle} of the placed door
|
|
653
656
|
* @throws if the catalog id is unknown, the host is not a wall, the source
|
|
654
657
|
* mesh fails to load, or the projected point falls **outside** the host wall
|
|
@@ -659,6 +662,7 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
659
662
|
* @examplePrompt Insert the entrance door into this wall
|
|
660
663
|
* @examplePrompt Add a door to the wall and call it Entry-01
|
|
661
664
|
* @examplePrompt Add a door that opens into the living room
|
|
665
|
+
* @examplePrompt Put a door here hinged on the north jamb
|
|
662
666
|
*
|
|
663
667
|
* # Example
|
|
664
668
|
* ```ts
|
|
@@ -678,6 +682,14 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
678
682
|
* undefined,
|
|
679
683
|
* await snaptrude.core.math.vec3.new(3, 0, 9),
|
|
680
684
|
* )
|
|
685
|
+
* // …and hinged on the jamb nearest a point (here the +x end of the opening):
|
|
686
|
+
* const hingedRight = await snaptrude.design.create.door(
|
|
687
|
+
* entry.id,
|
|
688
|
+
* wall,
|
|
689
|
+
* await snaptrude.core.math.vec3.new(3, 0, 5),
|
|
690
|
+
* { hinge: await snaptrude.core.math.vec3.new(3.5, 0, 5) },
|
|
691
|
+
* await snaptrude.core.math.vec3.new(3, 0, 9),
|
|
692
|
+
* )
|
|
681
693
|
* ```
|
|
682
694
|
*
|
|
683
695
|
* @performance For MORE THAN ONE door, call `design.create.doors(items[])` — one host
|
|
@@ -686,6 +698,7 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
686
698
|
*/
|
|
687
699
|
abstract door(catalogId: string, hostWall: ComponentHandle, position: Vec3Handle, options?: {
|
|
688
700
|
label?: string;
|
|
701
|
+
hinge?: Vec3Handle;
|
|
689
702
|
}, facing?: Vec3Handle): PluginApiReturn<ComponentHandle>;
|
|
690
703
|
/**
|
|
691
704
|
* Place **many doors** into host walls in one undoable operation (bulk plural
|
|
@@ -706,8 +719,8 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
706
719
|
* @returns the placed doors as {@linkcode ComponentHandle}`[]`, in input order
|
|
707
720
|
* @throws `VALIDATION` if the items fail the schema (empty array, more than
|
|
708
721
|
* 1000 items, unknown fields, a non-positive `width`/`height`);
|
|
709
|
-
* `HANDLE_INVALID` if a `position` or `
|
|
710
|
-
* released; `PRECONDITION_FAILED` if a catalog id is unknown, a `hostWall`
|
|
722
|
+
* `HANDLE_INVALID` if a `position`, `facing` or `hinge` handle is unknown
|
|
723
|
+
* or released; `PRECONDITION_FAILED` if a catalog id is unknown, a `hostWall`
|
|
711
724
|
* is not a wall / is locked / is not in the active proposal, the projected
|
|
712
725
|
* point falls outside its host wall, or a door tool is active;
|
|
713
726
|
* `OPERATION_FAILED` if a source mesh fails to load or placement fails
|
|
@@ -752,11 +765,14 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
752
765
|
* @param catalogId - Library id: team `_id` or general `fullName`
|
|
753
766
|
* @param hostWall - The wall to host the window
|
|
754
767
|
* @param position - World point projected onto the wall to locate the opening
|
|
755
|
-
* @param options - Optional placement options: `label` — instance name
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
768
|
+
* @param options - Optional placement options: `label` — instance name;
|
|
769
|
+
* `hinge` — world point near the jamb the window is hinged on (same rule
|
|
770
|
+
* as {@linkcode PluginDesignCreateApi.door}; default the catalog item's
|
|
771
|
+
* authored side)
|
|
772
|
+
* @param facing - World point on the side of the wall the window opens to
|
|
773
|
+
* (matters for asymmetric windows, e.g. casement swing) — same convention
|
|
774
|
+
* as {@linkcode PluginDesignCreateApi.door}. Default: the engine picks a
|
|
775
|
+
* side (nondeterministic when `position` sits on the centerline).
|
|
760
776
|
* @returns the {@linkcode ComponentHandle} of the placed window
|
|
761
777
|
* @throws if the catalog id is unknown, the host is not a wall, the source
|
|
762
778
|
* mesh fails to load, or the projected point falls **outside** the host wall
|
|
@@ -786,6 +802,7 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
786
802
|
*/
|
|
787
803
|
abstract window(catalogId: string, hostWall: ComponentHandle, position: Vec3Handle, options?: {
|
|
788
804
|
label?: string;
|
|
805
|
+
hinge?: Vec3Handle;
|
|
789
806
|
}, facing?: Vec3Handle): PluginApiReturn<ComponentHandle>;
|
|
790
807
|
/**
|
|
791
808
|
* Place **many windows** into host walls in one undoable operation (bulk
|
|
@@ -808,8 +825,8 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
808
825
|
* @returns the placed windows as {@linkcode ComponentHandle}`[]`, in input order
|
|
809
826
|
* @throws `VALIDATION` if the items fail the schema (empty array, more than
|
|
810
827
|
* 1000 items, unknown fields, a non-positive `width`/`height`, a negative
|
|
811
|
-
* `sillHeight`); `HANDLE_INVALID` if a `position` or `
|
|
812
|
-
* unknown or released; `PRECONDITION_FAILED` if a catalog id is unknown, a
|
|
828
|
+
* `sillHeight`); `HANDLE_INVALID` if a `position`, `facing` or `hinge`
|
|
829
|
+
* handle is unknown or released; `PRECONDITION_FAILED` if a catalog id is unknown, a
|
|
813
830
|
* `hostWall` is not a wall / is locked / is not in the active proposal, the
|
|
814
831
|
* projected point falls outside its host wall, or a window tool is active;
|
|
815
832
|
* `OPERATION_FAILED` if a source mesh fails to load or placement fails
|
|
@@ -849,7 +866,7 @@ export declare abstract class PluginDesignCreateApi {
|
|
|
849
866
|
* its center. Placement is asynchronous and committed as one undoable creation.
|
|
850
867
|
*
|
|
851
868
|
* @param options - Opening kind, catalog and host references, placement, and
|
|
852
|
-
* optional facing, label, and dimensions
|
|
869
|
+
* optional facing (swing side), hinge (hinged jamb), label, and dimensions
|
|
853
870
|
* @returns the {@linkcode ComponentHandle} of the placed door or window
|
|
854
871
|
* @throws if the options are invalid, the catalog id is unknown, the host is
|
|
855
872
|
* not a wall, loading fails, or the opening cannot be placed on the host
|
|
@@ -1401,7 +1418,8 @@ export type PluginDesignCreateFurnitureArgs = z.infer<typeof PluginDesignCreateF
|
|
|
1401
1418
|
* | `hostWall` | {@linkcode ComponentHandle} | The wall to host the door |
|
|
1402
1419
|
* | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
|
|
1403
1420
|
* | `label` | `string`? | Instance name (optional) |
|
|
1404
|
-
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the door
|
|
1421
|
+
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the door swings open to (default engine-chosen) |
|
|
1422
|
+
* | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the door is hinged on (default the catalog item's authored side) |
|
|
1405
1423
|
*/
|
|
1406
1424
|
export declare const PluginDesignCreateDoorArgs: z.ZodObject<{
|
|
1407
1425
|
catalogId: z.ZodString;
|
|
@@ -1409,6 +1427,7 @@ export declare const PluginDesignCreateDoorArgs: z.ZodObject<{
|
|
|
1409
1427
|
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
1410
1428
|
label: z.ZodOptional<z.ZodString>;
|
|
1411
1429
|
facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1430
|
+
hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1412
1431
|
}, z.core.$strip>;
|
|
1413
1432
|
export type PluginDesignCreateDoorArgs = z.infer<typeof PluginDesignCreateDoorArgs>;
|
|
1414
1433
|
/**
|
|
@@ -1420,7 +1439,8 @@ export type PluginDesignCreateDoorArgs = z.infer<typeof PluginDesignCreateDoorAr
|
|
|
1420
1439
|
* | `hostWall` | {@linkcode ComponentHandle} | The wall to host the window |
|
|
1421
1440
|
* | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
|
|
1422
1441
|
* | `label` | `string`? | Instance name (optional) |
|
|
1423
|
-
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the window
|
|
1442
|
+
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the window opens to (default engine-chosen) |
|
|
1443
|
+
* | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the window is hinged on (default the catalog item's authored side) |
|
|
1424
1444
|
*/
|
|
1425
1445
|
export declare const PluginDesignCreateWindowArgs: z.ZodObject<{
|
|
1426
1446
|
catalogId: z.ZodString;
|
|
@@ -1428,6 +1448,7 @@ export declare const PluginDesignCreateWindowArgs: z.ZodObject<{
|
|
|
1428
1448
|
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
1429
1449
|
label: z.ZodOptional<z.ZodString>;
|
|
1430
1450
|
facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1451
|
+
hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1431
1452
|
}, z.core.$strip>;
|
|
1432
1453
|
export type PluginDesignCreateWindowArgs = z.infer<typeof PluginDesignCreateWindowArgs>;
|
|
1433
1454
|
/**
|
|
@@ -1441,6 +1462,7 @@ export declare const PluginDesignCreateOpeningOptions: z.ZodDiscriminatedUnion<[
|
|
|
1441
1462
|
hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
1442
1463
|
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
1443
1464
|
facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1465
|
+
hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1444
1466
|
label: z.ZodOptional<z.ZodString>;
|
|
1445
1467
|
width: z.ZodOptional<z.ZodNumber>;
|
|
1446
1468
|
height: z.ZodOptional<z.ZodNumber>;
|
|
@@ -1451,6 +1473,7 @@ export declare const PluginDesignCreateOpeningOptions: z.ZodDiscriminatedUnion<[
|
|
|
1451
1473
|
hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
1452
1474
|
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
1453
1475
|
facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1476
|
+
hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
1454
1477
|
label: z.ZodOptional<z.ZodString>;
|
|
1455
1478
|
width: z.ZodOptional<z.ZodNumber>;
|
|
1456
1479
|
height: z.ZodOptional<z.ZodNumber>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EACL,UAAU,EACV,eAAe,EACf,aAAa,EACb,aAAa,EACb,UAAU,EACX,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,eAAe,EACf,cAAc,EACd,kBAAkB,EACnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,gCAAgC,CAAA;AAEvC,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,cAAc,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,UAAU,EACrB,SAAS,CAAC,EAAE,eAAe,EAC3B,QAAQ,CAAC,EAAE,cAAc,EACzB,YAAY,CAAC,EAAE,kBAAkB,EACjC,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,UAAU,EACrB,QAAQ,CAAC,EAAE,cAAc,GACxB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,YAAY,CAC1B,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,EACzB,QAAQ,CAAC,EAAE,cAAc,GACxB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,UAAU,GACpB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,MAAM,CACpB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,GAChB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,CACrB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,eAAe,CAAC,EAAE,MAAM,GACvB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,QAAQ,EAAE,UAAU,EACpB,YAAY,EAAE,aAAa,EAC3B,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,UAAU,GACvB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,UAAU,GACrB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;aACa,QAAQ,CACtB,KAAK,EAAE,uBAAuB,EAAE,GAC/B,eAAe,CAAC,eAAe,EAAE,EAAE,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;aACa,SAAS,CACvB,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,EAAE,UAAU,EACpB,KAAK,CAAC,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,KAAK,CAAC,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,yBAAyB,GACrC,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,cAAc,CAC5B,OAAO,EAAE,aAAa,EACtB,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,MAAM,GACf,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;aACa,SAAS,CACvB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,UAAU,EACpB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,EAC3D,cAAc,CAAC,EAAE,MAAM,GACtB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,cAAc,CAC5B,KAAK,EAAE,yBAAyB,EAAE,GACjC,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EACL,UAAU,EACV,eAAe,EACf,aAAa,EACb,aAAa,EACb,UAAU,EACX,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,eAAe,EACf,cAAc,EACd,kBAAkB,EACnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,gCAAgC,CAAA;AAEvC,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,cAAc,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,UAAU,EACrB,SAAS,CAAC,EAAE,eAAe,EAC3B,QAAQ,CAAC,EAAE,cAAc,EACzB,YAAY,CAAC,EAAE,kBAAkB,EACjC,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,UAAU,EACrB,QAAQ,CAAC,EAAE,cAAc,GACxB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,YAAY,CAC1B,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,EACzB,QAAQ,CAAC,EAAE,cAAc,GACxB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,UAAU,GACpB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,MAAM,CACpB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,GAChB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,CACrB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,MAAM,EACjB,eAAe,CAAC,EAAE,MAAM,GACvB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,QAAQ,EAAE,UAAU,EACpB,YAAY,EAAE,aAAa,EAC3B,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,UAAU,GACvB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,IAAI,CAClB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,UAAU,GACrB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;aACa,QAAQ,CACtB,KAAK,EAAE,uBAAuB,EAAE,GAC/B,eAAe,CAAC,eAAe,EAAE,EAAE,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;aACa,SAAS,CACvB,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,EAAE,UAAU,EACpB,KAAK,CAAC,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,KAAK,CAAC,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,yBAAyB,GACrC,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,cAAc,CAC5B,OAAO,EAAE,aAAa,EACtB,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,MAAM,GACf,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;aACa,SAAS,CACvB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,UAAU,EACpB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,EAC3D,cAAc,CAAC,EAAE,MAAM,GACtB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,cAAc,CAC5B,KAAK,EAAE,yBAAyB,EAAE,GACjC,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;aACa,IAAI,CAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,UAAU,EACpB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,EAChD,MAAM,CAAC,EAAE,UAAU,GAClB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,KAAK,CACnB,KAAK,EAAE,oBAAoB,EAAE,GAC5B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;aACa,MAAM,CACpB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,UAAU,EACpB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,EAChD,MAAM,CAAC,EAAE,UAAU,GAClB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;aACa,OAAO,CACrB,KAAK,EAAE,sBAAsB,EAAE,GAC9B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,OAAO,CACrB,OAAO,EAAE,gCAAgC,GACxC,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;aACa,WAAW,CACzB,OAAO,EAAE,qBAAqB,GAC7B,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,EAC7B,YAAY,EAAE,UAAU,EACxB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,cAAc,CAAA;KAAE,GAClD,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,MAAM,CACpB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,iBAAiB,CAC/B,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;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;EAA0C,CAAA;AAC/E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;;;;;EAKzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;EAiBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;kBAQ3B,CAAA;AACX,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAMD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAStC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAQD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;iBAMrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAMD;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAMD;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;iBAKrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;iBAItC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAMD;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,6BAA6B;;;;iBAIxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAMD;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAKvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;;iBAIrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAMD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAMtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAQD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAMD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,+BAA+B;;;;;;iBAM1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAQD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B;;;;;;;iBAOrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAQD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B;;;;;;;iBAOvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAQD;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;4BAc3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAMD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;;;iBAc/B,CAAA;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;iBASlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAM7E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oCAAoC;;;;;;;;;;iBAM/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAMD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;;EAAiC,CAAA;AAC5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;iBAKrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAQD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAShC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA"}
|
|
@@ -5,14 +5,21 @@ import { ComponentHandle } from "../../../handles";
|
|
|
5
5
|
* {@linkcode PluginDesignCreateOpeningOptions} and by the bulk item schemas in
|
|
6
6
|
* `bulk-items.ts`, so singular and plural openings validate identically.
|
|
7
7
|
*
|
|
8
|
-
* `facing`
|
|
8
|
+
* `facing` and `hinge` are WORLD POINTS, not directions: `facing` sits on the
|
|
9
|
+
* side of the wall the leaf swings open to (where the plan symbol draws the
|
|
10
|
+
* swing arc); `hinge` sits near the jamb the leaf is hinged on — the item is
|
|
11
|
+
* reflected along the wall so its hinged jamb is the one nearer that point.
|
|
12
|
+
* Either may be omitted (engine-chosen side / the catalog item's authored
|
|
13
|
+
* hinge side). Neither has a visible effect on symmetric items such as
|
|
14
|
+
* sliders or fixed windows.
|
|
9
15
|
*
|
|
10
16
|
* | Property | Type | Description |
|
|
11
17
|
* |---|---|---|
|
|
12
18
|
* | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
|
|
13
19
|
* | `hostWall` | {@linkcode ComponentHandle} | The wall to host the opening |
|
|
14
20
|
* | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
|
|
15
|
-
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the opening
|
|
21
|
+
* | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the opening swings open to (default engine-chosen) |
|
|
22
|
+
* | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the opening is hinged on (default the catalog item's authored side) |
|
|
16
23
|
* | `label` | `string`? | Instance name (optional) |
|
|
17
24
|
* | `width` | `number`? | Width override (Snaptrude units, > 0; default the catalog item's) |
|
|
18
25
|
* | `height` | `number`? | Height override (Snaptrude units, > 0; default the catalog item's) |
|
|
@@ -22,6 +29,7 @@ export declare const PluginOpeningBaseOptions: {
|
|
|
22
29
|
hostWall: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
23
30
|
position: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
24
31
|
facing: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
32
|
+
hinge: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
25
33
|
label: z.ZodOptional<z.ZodString>;
|
|
26
34
|
width: z.ZodOptional<z.ZodNumber>;
|
|
27
35
|
height: z.ZodOptional<z.ZodNumber>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"opening-fields.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/opening-fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAc,MAAM,kBAAkB,CAAA;AAE9D
|
|
1
|
+
{"version":3,"file":"opening-fields.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/opening-fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAc,MAAM,kBAAkB,CAAA;AAE9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;CASpC,CAAA"}
|
|
@@ -7,9 +7,11 @@ import { PluginDesignChangeResult } from "../lock";
|
|
|
7
7
|
* `design.create.door`; generic reads (`listDoors`/`getHost`/`getProperties`) live at
|
|
8
8
|
* `design.query.*`. Door targets are {@linkcode ComponentHandle}s.
|
|
9
9
|
*
|
|
10
|
-
* `getSwingDirection` is a DERIVED read (no persisted field) — computed from the
|
|
11
|
-
* mesh
|
|
12
|
-
*
|
|
10
|
+
* `getSwingDirection` is a DERIVED read (no persisted field) — computed from the placed
|
|
11
|
+
* mesh's orientation: stand on the side the door swings open to, facing it; `'left'`
|
|
12
|
+
* when the hinged jamb is on your left. `mirror` reflects the door about one of its own
|
|
13
|
+
* axes (undoable, one command): `'x'` flips the swing side, `'z'` swaps the hinged jamb;
|
|
14
|
+
* `setType` is intentionally absent (the engine has no in-place re-type —
|
|
13
15
|
* it would require delete+recreate).
|
|
14
16
|
*
|
|
15
17
|
* The **catalog** reads (`listCatalogGroups`/`listCatalog`/`getCatalogItem`/`exists`)
|
|
@@ -144,9 +146,11 @@ export declare abstract class PluginDesignDoorsApi {
|
|
|
144
146
|
*/
|
|
145
147
|
abstract getSupportFloor(door: ComponentHandle): PluginApiReturn<ComponentHandle | null>;
|
|
146
148
|
/**
|
|
147
|
-
* Get a door's swing (hinge) handedness
|
|
148
|
-
*
|
|
149
|
-
*
|
|
149
|
+
* Get a door's swing (hinge) handedness. Stand on the side the door swings
|
|
150
|
+
* open to, facing the door: `'left'` when the hinged jamb is on your left,
|
|
151
|
+
* `'right'` when it is on your right. Derived from the placed mesh's
|
|
152
|
+
* orientation (the same reflection `mirror` and the `hinge` placement option
|
|
153
|
+
* apply), not a persisted field.
|
|
150
154
|
*
|
|
151
155
|
* @param door The door to query
|
|
152
156
|
* @returns `'left'` / `'right'`, or `null` if indeterminate
|
|
@@ -165,11 +169,13 @@ export declare abstract class PluginDesignDoorsApi {
|
|
|
165
169
|
*/
|
|
166
170
|
abstract getSwingDirection(door: ComponentHandle): PluginApiReturn<"left" | "right" | null>;
|
|
167
171
|
/**
|
|
168
|
-
* Mirror a door
|
|
169
|
-
* other side
|
|
172
|
+
* Mirror a door about its own axes. `'x'` (default) flips the swing side —
|
|
173
|
+
* the door opens to the other side of the wall; `'z'` swaps the hinged jamb
|
|
174
|
+
* (left-hand ↔ right-hand, same swing side); `'y'` turns it upside down.
|
|
175
|
+
* Undoable as a single command.
|
|
170
176
|
*
|
|
171
177
|
* @param door The door to mirror
|
|
172
|
-
* @param axis Reflection axis (optional; default `'x'` — the swing-flip axis)
|
|
178
|
+
* @param axis Reflection axis (optional; default `'x'` — the swing-flip axis; `'z'` — the hinge-jamb axis)
|
|
173
179
|
* @returns The affected door(s)
|
|
174
180
|
*
|
|
175
181
|
* @examplePrompt Flip this door's swing
|
|
@@ -180,10 +186,11 @@ export declare abstract class PluginDesignDoorsApi {
|
|
|
180
186
|
*
|
|
181
187
|
* # Example
|
|
182
188
|
* ```ts
|
|
183
|
-
* // Flip the selected door's swing — axis defaults to "x"
|
|
184
|
-
* // axis); pass "y" or "z" to reflect across a different axis
|
|
189
|
+
* // Flip the selected door's swing side — axis defaults to "x"
|
|
185
190
|
* const [door] = await snaptrude.design.query.listDoors({ isSelected: true })
|
|
186
191
|
* const { affected } = await snaptrude.design.doors.mirror(door)
|
|
192
|
+
* // …or swap the hinged jamb instead (keeps the swing side)
|
|
193
|
+
* await snaptrude.design.doors.mirror(door, "z")
|
|
187
194
|
* ```
|
|
188
195
|
*/
|
|
189
196
|
abstract mirror(door: ComponentHandle, axis?: PluginMirrorAxis): PluginApiReturn<PluginDesignChangeResult>;
|
|
@@ -334,7 +341,7 @@ export declare const PluginDoorDimensions: z.ZodObject<{
|
|
|
334
341
|
thickness: z.ZodNumber;
|
|
335
342
|
}, z.core.$strip>;
|
|
336
343
|
export type PluginDoorDimensions = z.infer<typeof PluginDoorDimensions>;
|
|
337
|
-
/** Mirror axis — tokens mirror the engine `FlipDirection` verbatim
|
|
344
|
+
/** Mirror axis — tokens mirror the engine `FlipDirection` verbatim: `'x'` flips the swing side, `'z'` swaps the hinged jamb, `'y'` turns the door upside down. */
|
|
338
345
|
export declare const PluginMirrorAxis: z.ZodEnum<{
|
|
339
346
|
x: "x";
|
|
340
347
|
y: "y";
|
|
@@ -347,7 +354,7 @@ export type PluginMirrorAxis = z.infer<typeof PluginMirrorAxis>;
|
|
|
347
354
|
* | Property | Type | Description |
|
|
348
355
|
* |---|---|---|
|
|
349
356
|
* | `door` | {@linkcode ComponentHandle} | The door to mirror |
|
|
350
|
-
* | `axis` | {@linkcode PluginMirrorAxis} | Reflection axis (optional; default `'x'` — the swing-flip axis) |
|
|
357
|
+
* | `axis` | {@linkcode PluginMirrorAxis} | Reflection axis (optional; default `'x'` — the swing-flip axis; `'z'` — the hinge-jamb axis) |
|
|
351
358
|
*/
|
|
352
359
|
export declare const PluginDesignDoorMirrorArgs: z.ZodObject<{
|
|
353
360
|
door: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/doors/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;AAElD
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/doors/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;AAElD;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAE9E;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhF;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhF;;;;;;;;;;;;;;;;;;;OAmBG;aACa,aAAa,CAC3B,IAAI,EAAE,eAAe,GACpB,eAAe,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAE/C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,eAAe,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,CAAC,eAAe,GAAG,IAAI,CAAC;IAE/F;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,iBAAiB,CAC/B,IAAI,EAAE,eAAe,GACpB,eAAe,CAAC,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,IAAI,EAAE,eAAe,EACrB,IAAI,CAAC,EAAE,gBAAgB,GACtB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,KAAK,EAAE,eAAe,EAAE,EACxB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,KAAK,EAAE,eAAe,EAAE,EACxB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;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,oBAAoB;;iBAE/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;iBAI/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,kKAAkK;AAClK,eAAO,MAAM,gBAAgB;;;;EAA0B,CAAA;AACvD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAMzF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBASlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,eAAO,MAAM,0BAA0B;;iBAAqC,CAAA;AAC5E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA"}
|
|
@@ -6,7 +6,7 @@ import { ComponentHandle } from "../../handles";
|
|
|
6
6
|
* Program departments — read the department groupings of the active program.
|
|
7
7
|
*
|
|
8
8
|
* In program mode a **department** is a named, colored grouping of spaces with an
|
|
9
|
-
* optional area **target
|
|
9
|
+
* optional gross area **target** and a unit **count** target. This is the program-planning view of departments
|
|
10
10
|
* (their identity, color, and target area); the underlying space geometry is read
|
|
11
11
|
* and edited through the geometry namespaces, not here.
|
|
12
12
|
*
|
|
@@ -180,6 +180,29 @@ export declare abstract class PluginProgramDepartmentsApi {
|
|
|
180
180
|
* ```
|
|
181
181
|
*/
|
|
182
182
|
abstract setTargetArea(departmentId: string, targetArea: number, units?: PluginAreaUnit): PluginApiReturn<PluginProgramDepartmentsSetTargetAreaResult>;
|
|
183
|
+
/**
|
|
184
|
+
* Set a department's target unit count.
|
|
185
|
+
*
|
|
186
|
+
* The number of units (program blocks) the department is planned for — the
|
|
187
|
+
* count twin of {@linkcode PluginProgramDepartmentsApi.setTargetArea}, stored
|
|
188
|
+
* beside the gross area target on the department. Read it back from
|
|
189
|
+
* {@linkcode PluginProgramDepartmentsApi.get} (`targetCount`).
|
|
190
|
+
*
|
|
191
|
+
* @param departmentId - The id of the department whose count to set.
|
|
192
|
+
* @param targetCount - The target number of units (a non-negative integer).
|
|
193
|
+
* @returns The updated {@linkcode PluginProgramDepartment} with its `units`.
|
|
194
|
+
* @throws If no department has the given id.
|
|
195
|
+
*
|
|
196
|
+
* @examplePrompt Set the Bedrooms department unit count to 12
|
|
197
|
+
* @examplePrompt The program needs 4 clinic blocks — update the department count
|
|
198
|
+
* @examplePrompt Update the target count for department dep_123
|
|
199
|
+
*
|
|
200
|
+
* # Example
|
|
201
|
+
* ```ts
|
|
202
|
+
* await snaptrude.program.departments.setTargetCount("dep_123", 12)
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
abstract setTargetCount(departmentId: string, targetCount: number): PluginApiReturn<PluginProgramDepartmentsSetTargetCountResult>;
|
|
183
206
|
/**
|
|
184
207
|
* Delete a department.
|
|
185
208
|
*
|
|
@@ -213,13 +236,15 @@ export declare abstract class PluginProgramDepartmentsApi {
|
|
|
213
236
|
* | `id` | `string` | Unique department id |
|
|
214
237
|
* | `name` | `string` | Display name |
|
|
215
238
|
* | `color` | `string` | CSS hex color string (e.g. `"#b5e1dc"`) |
|
|
216
|
-
* | `targetArea` | `number \| null` |
|
|
239
|
+
* | `targetArea` | `number \| null` | Gross target area in the response's `units`, or `null` if no target is set |
|
|
240
|
+
* | `targetCount` | `number` | Target number of units / program blocks (`0` when unset) |
|
|
217
241
|
*/
|
|
218
242
|
export declare const PluginProgramDepartment: z.ZodObject<{
|
|
219
243
|
id: z.ZodString;
|
|
220
244
|
name: z.ZodString;
|
|
221
245
|
color: z.ZodString;
|
|
222
246
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
247
|
+
targetCount: z.ZodNumber;
|
|
223
248
|
}, z.core.$strip>;
|
|
224
249
|
export type PluginProgramDepartment = z.infer<typeof PluginProgramDepartment>;
|
|
225
250
|
/**
|
|
@@ -241,6 +266,7 @@ export declare const PluginProgramDepartmentsListResult: z.ZodObject<{
|
|
|
241
266
|
name: z.ZodString;
|
|
242
267
|
color: z.ZodString;
|
|
243
268
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
269
|
+
targetCount: z.ZodNumber;
|
|
244
270
|
}, z.core.$strip>>;
|
|
245
271
|
}, z.core.$strip>;
|
|
246
272
|
export type PluginProgramDepartmentsListResult = z.infer<typeof PluginProgramDepartmentsListResult>;
|
|
@@ -265,6 +291,7 @@ export declare const PluginProgramDepartmentsGetResult: z.ZodNullable<z.ZodObjec
|
|
|
265
291
|
name: z.ZodString;
|
|
266
292
|
color: z.ZodString;
|
|
267
293
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
294
|
+
targetCount: z.ZodNumber;
|
|
268
295
|
units: z.ZodEnum<{
|
|
269
296
|
ft2: "ft2";
|
|
270
297
|
m2: "m2";
|
|
@@ -281,6 +308,7 @@ export declare const PluginProgramDepartmentRecord: z.ZodObject<{
|
|
|
281
308
|
name: z.ZodString;
|
|
282
309
|
color: z.ZodString;
|
|
283
310
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
311
|
+
targetCount: z.ZodNumber;
|
|
284
312
|
units: z.ZodEnum<{
|
|
285
313
|
ft2: "ft2";
|
|
286
314
|
m2: "m2";
|
|
@@ -330,6 +358,7 @@ export declare const PluginProgramDepartmentsUpdateResult: z.ZodObject<{
|
|
|
330
358
|
name: z.ZodString;
|
|
331
359
|
color: z.ZodString;
|
|
332
360
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
361
|
+
targetCount: z.ZodNumber;
|
|
333
362
|
units: z.ZodEnum<{
|
|
334
363
|
ft2: "ft2";
|
|
335
364
|
m2: "m2";
|
|
@@ -398,12 +427,39 @@ export declare const PluginProgramDepartmentsSetTargetAreaResult: z.ZodObject<{
|
|
|
398
427
|
name: z.ZodString;
|
|
399
428
|
color: z.ZodString;
|
|
400
429
|
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
430
|
+
targetCount: z.ZodNumber;
|
|
401
431
|
units: z.ZodEnum<{
|
|
402
432
|
ft2: "ft2";
|
|
403
433
|
m2: "m2";
|
|
404
434
|
}>;
|
|
405
435
|
}, z.core.$strip>;
|
|
406
436
|
export type PluginProgramDepartmentsSetTargetAreaResult = z.infer<typeof PluginProgramDepartmentsSetTargetAreaResult>;
|
|
437
|
+
/**
|
|
438
|
+
* Arguments for {@linkcode PluginProgramDepartmentsApi.setTargetCount}.
|
|
439
|
+
*
|
|
440
|
+
* | Property | Type | Description |
|
|
441
|
+
* |---|---|---|
|
|
442
|
+
* | `departmentId` | `string` | The id of the department whose count to set |
|
|
443
|
+
* | `targetCount` | `number` | Target number of units (non-negative integer) |
|
|
444
|
+
*/
|
|
445
|
+
export declare const PluginProgramDepartmentsSetTargetCountArgs: z.ZodObject<{
|
|
446
|
+
departmentId: z.ZodString;
|
|
447
|
+
targetCount: z.ZodNumber;
|
|
448
|
+
}, z.core.$strip>;
|
|
449
|
+
export type PluginProgramDepartmentsSetTargetCountArgs = z.infer<typeof PluginProgramDepartmentsSetTargetCountArgs>;
|
|
450
|
+
/** Result of {@linkcode PluginProgramDepartmentsApi.setTargetCount} — the updated record with `units`. */
|
|
451
|
+
export declare const PluginProgramDepartmentsSetTargetCountResult: z.ZodObject<{
|
|
452
|
+
id: z.ZodString;
|
|
453
|
+
name: z.ZodString;
|
|
454
|
+
color: z.ZodString;
|
|
455
|
+
targetArea: z.ZodNullable<z.ZodNumber>;
|
|
456
|
+
targetCount: z.ZodNumber;
|
|
457
|
+
units: z.ZodEnum<{
|
|
458
|
+
ft2: "ft2";
|
|
459
|
+
m2: "m2";
|
|
460
|
+
}>;
|
|
461
|
+
}, z.core.$strip>;
|
|
462
|
+
export type PluginProgramDepartmentsSetTargetCountResult = z.infer<typeof PluginProgramDepartmentsSetTargetCountResult>;
|
|
407
463
|
/**
|
|
408
464
|
* Arguments for {@linkcode PluginProgramDepartmentsApi.delete}.
|
|
409
465
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"departments.d.ts","sourceRoot":"","sources":["../../../src/api/program/departments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;GAYG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,IAAI,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAE3E;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,YAAY,EAAE,MAAM,GACnB,eAAe,CAAC,iCAAiC,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,eAAe,EAAE,GAC1B,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,QAAQ,EAAE,eAAe,EAAE,GAC1B,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,GACrB,eAAe,CAAC,2CAA2C,CAAC;IAE/D;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,MAAM,CAAC,EAAE,CACd,YAAY,EAAE,MAAM,KACjB,eAAe,CAAC,oCAAoC,CAAC,CAAA;CAC3D;AAED
|
|
1
|
+
{"version":3,"file":"departments.d.ts","sourceRoot":"","sources":["../../../src/api/program/departments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;GAYG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,IAAI,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAE3E;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,YAAY,EAAE,MAAM,GACnB,eAAe,CAAC,iCAAiC,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,eAAe,EAAE,GAC1B,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,QAAQ,CACtB,QAAQ,EAAE,eAAe,EAAE,GAC1B,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,GACrB,eAAe,CAAC,2CAA2C,CAAC;IAE/D;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,cAAc,CAC5B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,GAClB,eAAe,CAAC,4CAA4C,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,MAAM,CAAC,EAAE,CACd,YAAY,EAAE,MAAM,KACjB,eAAe,CAAC,oCAAoC,CAAC,CAAA;CAC3D;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAMlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;kBAIlC,CAAA;AACZ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,kCAAkC;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,qFAAqF;AACrF,eAAO,MAAM,oCAAoC;;;;;;;;;;iBAClB,CAAA;AAC/B,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,oCAAoC;;;iBAG/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,kEAAkE;AAClE,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,yCAAyC;;;;;;;iBAIpD,CAAA;AACF,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,2CAA2C;;;;;;;;;;iBACzB,CAAA;AAC/B,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0CAA0C;;;iBAGrD,CAAA;AACF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED,0GAA0G;AAC1G,eAAO,MAAM,4CAA4C;;;;;;;;;;iBAC1B,CAAA;AAC/B,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,4CAA4C,CACpD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;iBAG/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA"}
|
|
@@ -7,21 +7,25 @@ import { PluginProgramSiteApi } from "./site";
|
|
|
7
7
|
import { PluginProgramCoresApi } from "./cores";
|
|
8
8
|
import { PluginProgramClassificationApi } from "./classification";
|
|
9
9
|
import { PluginProgramAreasApi } from "./areas";
|
|
10
|
+
import { PluginProgramMetadataApi } from "./metadata";
|
|
11
|
+
import { PluginProgramLabelsApi } from "./labels";
|
|
10
12
|
/**
|
|
11
13
|
* Program-mode planning APIs.
|
|
12
14
|
*
|
|
13
15
|
* The program is the space-planning layer: department groupings with area targets,
|
|
14
|
-
* the
|
|
15
|
-
* that render program/takeoff data to
|
|
16
|
-
* *plan* (intent + targets); the geometry
|
|
17
|
-
* through the geometry namespaces.
|
|
16
|
+
* the labels (program rows) inside them, the metrics that track allocated area
|
|
17
|
+
* against those targets, and the reports that render program/takeoff data to
|
|
18
|
+
* spreadsheet sheets. Reads describe the *plan* (intent + targets); the geometry
|
|
19
|
+
* that realizes the plan is authored through the geometry namespaces.
|
|
18
20
|
*
|
|
19
21
|
* - {@linkcode PluginProgramApi.departments} — Read & edit program departments (groupings + targets)
|
|
22
|
+
* - {@linkcode PluginProgramApi.labels} — Read & edit program labels (program rows: per-type area/count targets)
|
|
23
|
+
* - {@linkcode PluginProgramApi.metadata} — Read & edit program metadata (custom columns) on spaces
|
|
20
24
|
* - {@linkcode PluginProgramApi.adjacency} — Read & compute the department/space adjacency matrix
|
|
21
25
|
* - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
|
|
22
26
|
* - {@linkcode PluginProgramApi.metrics} — Read the area-program summary
|
|
23
27
|
* - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
|
|
24
|
-
* - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets
|
|
28
|
+
* - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets, custom grouped sheets, read back
|
|
25
29
|
* - {@linkcode PluginProgramApi.site} — Read site/plot context and read/update Site Analysis
|
|
26
30
|
* - {@linkcode PluginProgramApi.cores} — Read & predicate vertical-circulation cores (reads only)
|
|
27
31
|
* - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
|
|
@@ -31,6 +35,10 @@ import { PluginProgramAreasApi } from "./areas";
|
|
|
31
35
|
export declare abstract class PluginProgramApi {
|
|
32
36
|
/** Program departments — groupings, area targets, and space assignment. See {@linkcode PluginProgramDepartmentsApi}. */
|
|
33
37
|
abstract departments: PluginProgramDepartmentsApi;
|
|
38
|
+
/** Program labels — the program rows with per-type area/count targets. See {@linkcode PluginProgramLabelsApi}. */
|
|
39
|
+
abstract labels: PluginProgramLabelsApi;
|
|
40
|
+
/** Program metadata — custom columns and their per-space values. See {@linkcode PluginProgramMetadataApi}. */
|
|
41
|
+
abstract metadata: PluginProgramMetadataApi;
|
|
34
42
|
/** Adjacency matrix — read & compute proximity relationships. See {@linkcode PluginProgramAdjacencyApi}. */
|
|
35
43
|
abstract adjacency: PluginProgramAdjacencyApi;
|
|
36
44
|
/** Arrange/pack spaces in the envelope (async job family). See {@linkcode PluginProgramLayoutApi}. */
|
|
@@ -39,7 +47,7 @@ export declare abstract class PluginProgramApi {
|
|
|
39
47
|
abstract metrics: PluginProgramMetricsApi;
|
|
40
48
|
/** FAR / built-up-area rollup and groupings. See {@linkcode PluginProgramAreasApi}. */
|
|
41
49
|
abstract areas: PluginProgramAreasApi;
|
|
42
|
-
/** Spreadsheet reports — render tables to sheets,
|
|
50
|
+
/** Spreadsheet reports — render tables to sheets, custom grouped sheets, export, read back. See {@linkcode PluginProgramSpreadsheetApi}. */
|
|
43
51
|
abstract spreadsheet: PluginProgramSpreadsheetApi;
|
|
44
52
|
/** Site/plot context and persisted Site Analysis. See {@linkcode PluginProgramSiteApi}. */
|
|
45
53
|
abstract site: PluginProgramSiteApi;
|
|
@@ -58,4 +66,6 @@ export * from "./site";
|
|
|
58
66
|
export * from "./cores";
|
|
59
67
|
export * from "./classification";
|
|
60
68
|
export * from "./areas";
|
|
69
|
+
export * from "./metadata";
|
|
70
|
+
export * from "./labels";
|
|
61
71
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -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;
|
|
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;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,kHAAkH;IAClH,SAAgB,MAAM,EAAE,sBAAsB,CAAA;IAC9C,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,wBAAwB,CAAA;IAClD,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,4IAA4I;IAC5I,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,2FAA2F;IAC3F,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,yGAAyG;IACzG,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;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}
|