@snaptrude/plugin-core 0.7.0 → 0.8.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.
- package/CHANGELOG.md +22 -0
- package/api-manifest.full.json +360 -19
- package/api-manifest.json +915 -37
- package/dist/api/core/camera/index.d.ts +208 -0
- package/dist/api/core/camera/index.d.ts.map +1 -0
- package/dist/api/core/comment/index.d.ts +105 -2
- package/dist/api/core/comment/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +13 -13
- package/dist/api/core/geom/delete/index.d.ts +8 -2
- package/dist/api/core/geom/delete/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/arc.d.ts +5 -5
- package/dist/api/core/geom/query/brep.d.ts +18 -18
- package/dist/api/core/geom/query/circle.d.ts +18 -18
- package/dist/api/core/geom/query/contour.d.ts +20 -20
- package/dist/api/core/geom/query/curve.d.ts +49 -49
- package/dist/api/core/geom/query/edge.d.ts +5 -5
- package/dist/api/core/geom/query/face.d.ts +16 -16
- package/dist/api/core/geom/query/halfedge.d.ts +8 -8
- package/dist/api/core/geom/query/profile.d.ts +19 -19
- package/dist/api/core/geom/query/vertex.d.ts +8 -8
- package/dist/api/core/geom/update/contour.d.ts +14 -14
- package/dist/api/core/geom/update/curve.d.ts +7 -7
- package/dist/api/core/geom/update/profile.d.ts +16 -16
- package/dist/api/core/handles/index.d.ts +210 -0
- package/dist/api/core/handles/index.d.ts.map +1 -0
- package/dist/api/core/index.d.ts +15 -0
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/io/export/index.d.ts +132 -0
- package/dist/api/core/io/export/index.d.ts.map +1 -0
- package/dist/api/core/io/import/index.d.ts +1 -1
- package/dist/api/core/io/index.d.ts +5 -0
- package/dist/api/core/io/index.d.ts.map +1 -1
- package/dist/api/core/layers.d.ts +7 -7
- package/dist/api/core/proposals/index.d.ts +65 -9
- package/dist/api/core/proposals/index.d.ts.map +1 -1
- package/dist/api/core/user.d.ts +44 -0
- package/dist/api/core/user.d.ts.map +1 -0
- package/dist/api/design/boolean/index.d.ts +4 -4
- package/dist/api/design/create/index.d.ts +139 -44
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +36 -0
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/edit/index.d.ts +1 -1
- package/dist/api/design/erase/index.d.ts +2 -2
- package/dist/api/design/furniture/index.d.ts +114 -3
- package/dist/api/design/furniture/index.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +10 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/materials/index.d.ts +111 -14
- package/dist/api/design/materials/index.d.ts.map +1 -1
- package/dist/api/design/query/index.d.ts +31 -1
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/query/spaces.d.ts +5 -5
- package/dist/api/design/transform/index.d.ts +83 -14
- package/dist/api/design/transform/index.d.ts.map +1 -1
- package/dist/api/design/types/index.d.ts +181 -0
- package/dist/api/design/types/index.d.ts.map +1 -0
- package/dist/api/design/update/index.d.ts +335 -2
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/visibility.d.ts +98 -0
- package/dist/api/design/visibility.d.ts.map +1 -0
- package/dist/api/entity/referenceLine.d.ts +2 -2
- package/dist/api/entity/space.d.ts +19 -19
- package/dist/api/entity/story.d.ts +128 -15
- package/dist/api/entity/story.d.ts.map +1 -1
- package/dist/api/presentation/aiInspiration.d.ts +1967 -7
- package/dist/api/presentation/aiInspiration.d.ts.map +1 -1
- package/dist/api/presentation/annotate.d.ts +448 -0
- package/dist/api/presentation/annotate.d.ts.map +1 -0
- package/dist/api/presentation/diagrams.d.ts +49 -8
- package/dist/api/presentation/diagrams.d.ts.map +1 -1
- package/dist/api/presentation/export.d.ts +104 -0
- package/dist/api/presentation/export.d.ts.map +1 -0
- package/dist/api/presentation/index.d.ts +40 -3
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/sheets.d.ts +410 -13
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/views.d.ts +165 -10
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/program/areas.d.ts +63 -3
- package/dist/api/program/areas.d.ts.map +1 -1
- package/dist/api/program/cores.d.ts +3 -99
- package/dist/api/program/cores.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +2 -2
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/layout.d.ts +172 -12
- package/dist/api/program/layout.d.ts.map +1 -1
- package/dist/api/program/site.d.ts +11 -8
- package/dist/api/program/site.d.ts.map +1 -1
- package/dist/api/program/spreadsheet.d.ts +105 -13
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/handles.d.ts +64 -25
- package/dist/handles.d.ts.map +1 -1
- package/dist/index.cjs +2502 -1466
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2369 -1461
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/api/core/camera/index.ts +212 -0
- package/src/api/core/comment/index.ts +120 -2
- package/src/api/core/geom/delete/index.ts +6 -0
- package/src/api/core/handles/index.ts +233 -0
- package/src/api/core/index.ts +15 -0
- package/src/api/core/io/export/index.ts +124 -0
- package/src/api/core/io/index.ts +5 -0
- package/src/api/core/proposals/index.ts +71 -11
- package/src/api/core/user.ts +46 -0
- package/src/api/design/create/index.ts +166 -36
- package/src/api/design/doors/index.ts +40 -0
- package/src/api/design/furniture/index.ts +127 -3
- package/src/api/design/index.ts +10 -0
- package/src/api/design/materials/index.ts +157 -30
- package/src/api/design/query/index.ts +33 -7
- package/src/api/design/transform/index.ts +89 -12
- package/src/api/design/types/index.ts +156 -0
- package/src/api/design/update/index.ts +402 -6
- package/src/api/design/visibility.ts +109 -0
- package/src/api/entity/story.ts +141 -15
- package/src/api/presentation/aiInspiration.ts +761 -7
- package/src/api/presentation/annotate.ts +360 -0
- package/src/api/presentation/diagrams.ts +53 -8
- package/src/api/presentation/export.ts +104 -0
- package/src/api/presentation/index.ts +48 -3
- package/src/api/presentation/sheets.ts +346 -13
- package/src/api/presentation/views.ts +164 -12
- package/src/api/program/areas.ts +57 -6
- package/src/api/program/cores.ts +3 -91
- package/src/api/program/index.ts +2 -2
- package/src/api/program/layout.ts +182 -12
- package/src/api/program/site.ts +11 -8
- package/src/api/program/spreadsheet.ts +125 -29
- package/src/handles.ts +77 -13
- package/tsconfig.json +7 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aiInspiration.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/aiInspiration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,QAAA,MAAM,aAAa,0EAA2D,CAAA;AAC9E,KAAK,SAAS,GACV,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAC7B,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAA;AAChC,QAAA,MAAM,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAEnC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;EAIxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;EAA6B,CAAA;AACxE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;EAAqC,CAAA;AAC9E,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;EAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;EAKzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;EAA6B,CAAA;AAC1E,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;iBAKxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,iCAAiC;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;iBAazC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;iBAuB3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;iBAK1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;iBAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,mCAAmC;;;;;;;;;;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;iBAStC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;iBAMpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,eAAO,MAAM,+BAA+B,uGAAkC,CAAA;AAC9E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;iBAUzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;iBAKxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,8BAAsB,kCAAkC;;IAGtD;;;;;;;;;;;;;;;OAeG;aACa,UAAU,IAAI,eAAe,CAAC,mCAAmC,CAAC;IAElF;;;;;;;;;;;;;;;OAeG;aACa,WAAW,CACzB,IAAI,EAAE,kCAAkC,GACvC,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,QAAQ,CACtB,IAAI,EAAE,+BAA+B,GACpC,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,IAAI,EAAE,6BAA6B,GAClC,eAAe,CAAC,4BAA4B,CAAC;CACjD"}
|
|
1
|
+
{"version":3,"file":"aiInspiration.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/aiInspiration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,QAAA,MAAM,aAAa,0EAA2D,CAAA;AAC9E,KAAK,SAAS,GACV,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAC7B,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAA;AAChC,QAAA,MAAM,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAEnC,CAAA;AAED,eAAO,MAAM,0BAA0B;;;EAA8B,CAAA;AACrE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;EAIxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;EAA6B,CAAA;AACxE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,kCAAkC;;;EAAyB,CAAA;AACxE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;EAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;EAAqC,CAAA;AAC9E,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;EAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;EAKzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;EAA6B,CAAA;AAC1E,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;;;EAMvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,mCAAmC;;;;;;EAM9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;iBAKxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,iCAAiC;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;iBAazC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;iBAuB3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;iBAK1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;iBAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;iBAY7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,mCAAmC;;;;;;;;;;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,2CAA2C;;iBAEtD,CAAA;AACF,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA;AAED,eAAO,MAAM,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;iBAExD,CAAA;AACF,MAAM,MAAM,6CAA6C,GAAG,CAAC,CAAC,KAAK,CACjE,OAAO,6CAA6C,CACrD,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;iBAStC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,eAAO,MAAM,kCAAkC;;;iBAG7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;iBAGhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED,eAAO,MAAM,uCAAuC;;;;iBAIlD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;iBAcpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGpD,CAAA;AACF,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;iBAMpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,eAAO,MAAM,+BAA+B,uGAAkC,CAAA;AAC9E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;iBAUzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAY1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;;;iBAMxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;iBAIzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,sCAAsC;;;;;iBAKjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED,eAAO,MAAM,0CAA0C;;;;;;;;;;;iBAMrD,CAAA;AACF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;iBAY1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAY1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAStC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,eAAO,MAAM,0CAA0C;;iBAErD,CAAA;AACF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED,eAAO,MAAM,4CAA4C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGvD,CAAA;AACF,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,4CAA4C,CACpD,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsElC,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;6BAnDpB,CAAA;AACD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED,eAAO,MAAM,0CAA0C;;;;;;;iBAIrD,CAAA;AACF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;;;;iBAKxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAOzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,8BAA8B,GAAG;IAC/B,OAAO,EAAE,CAAC,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAOD,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BAmB/C,CAAA;AACD,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAzCpC,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;iBAuCnB,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAxDnC,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;6BA+DpB,CAAA;AACD,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,mCAAmC;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED,eAAO,MAAM,6CAA6C;;iBAExD,CAAA;AACF,MAAM,MAAM,6CAA6C,GAAG,CAAC,CAAC,KAAK,CACjE,OAAO,6CAA6C,CACrD,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA7FhC,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAJR,CAAC;YACN,MAAM;sBACI,MAAM;mBACT,MAAM;mBACN,MAAM;;;;;;;iBA8FnB,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,kCAAkC;;IAGtD;;;;;;;;;;;;;;;OAeG;aACa,UAAU,IAAI,eAAe,CAAC,mCAAmC,CAAC;IAElF;;;;;;;;;;;;;;;;;;OAkBG;aACa,oBAAoB,CAClC,IAAI,EAAE,2CAA2C,GAChD,eAAe,CAAC,6CAA6C,CAAC;IAEjE;;;;;;;;;;;;;;;OAeG;aACa,WAAW,CACzB,IAAI,EAAE,kCAAkC,GACvC,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;OAaG;aACa,YAAY,IAAI,eAAe,CAAC,qCAAqC,CAAC;IAEtF;;;;;;;;;;;;;;;OAeG;aACa,gBAAgB,IAAI,eAAe,CAAC,yCAAyC,CAAC;IAE9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,QAAQ,CACtB,IAAI,EAAE,+BAA+B,GACpC,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,IAAI,EAAE,6BAA6B,GAClC,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;OAcG;aACa,SAAS,CACvB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;OAcG;aACa,QAAQ,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE9E;;;;;;;;;;;;;;;;OAgBG;aACa,mBAAmB,CACjC,IAAI,EAAE,0CAA0C,GAC/C,eAAe,CAAC,4CAA4C,CAAC;IAEhE;;;;;;;;;;;;;;;;;OAiBG;aACa,0BAA0B,CACxC,IAAI,EAAE,0CAA0C,GAC/C,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;OAiBG;aACa,mBAAmB,CACjC,IAAI,EAAE,0CAA0C,GAC/C,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;aACa,sBAAsB,CACpC,IAAI,EAAE,6CAA6C,GAClD,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;OAaG;aACa,WAAW,IAAI,eAAe,CAAC,oCAAoC,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,UAAU,CACxB,IAAI,EAAE,iCAAiC,GACtC,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,CAC1B,IAAI,EAAE,mCAAmC,GACxC,eAAe,CAAC,qCAAqC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,SAAS,CACvB,IAAI,EAAE,gCAAgC,GACrC,eAAe,CAAC,4BAA4B,CAAC;CACjD"}
|
|
@@ -0,0 +1,448 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../types";
|
|
3
|
+
/**
|
|
4
|
+
* Presentation annotate — add annotations to Present-mode sheets.
|
|
5
|
+
*
|
|
6
|
+
* The scriptable counterparts to the Present toolbar's annotation tools (all
|
|
7
|
+
* require Present mode to be open; each returns the created canvas shape id):
|
|
8
|
+
*
|
|
9
|
+
* - {@linkcode PluginPresentationAnnotateApi.text} — text labels (titles, captions)
|
|
10
|
+
* - {@linkcode PluginPresentationAnnotateApi.arrow} — arrows pointing between two points
|
|
11
|
+
* - {@linkcode PluginPresentationAnnotateApi.note} — sticky notes
|
|
12
|
+
* - {@linkcode PluginPresentationAnnotateApi.shape} — geo shapes (rectangle, ellipse, cloud, …)
|
|
13
|
+
*
|
|
14
|
+
* The freehand Draw tool is not scriptable (a stroke is an interactive gesture,
|
|
15
|
+
* not a single call) and is intentionally not exposed here.
|
|
16
|
+
*
|
|
17
|
+
* Accessed via `snaptrude.presentation.annotate`.
|
|
18
|
+
*/
|
|
19
|
+
export declare abstract class PluginPresentationAnnotateApi {
|
|
20
|
+
constructor();
|
|
21
|
+
/**
|
|
22
|
+
* Add a text label to a sheet.
|
|
23
|
+
*
|
|
24
|
+
* Creates a text shape on the given sheet and returns the id of the created
|
|
25
|
+
* canvas shape. Requires Present mode to be open.
|
|
26
|
+
*
|
|
27
|
+
* @param sheetId - The sheet to annotate.
|
|
28
|
+
* @param text - The label text.
|
|
29
|
+
* @param options - Optional `position` (`{ x, y }`, relative to the sheet's
|
|
30
|
+
* top-left, in canvas units — defaults to the sheet's top-left corner),
|
|
31
|
+
* `size` (`"s" | "m" | "l" | "xl"`, default `"m"`), and `color` (a named
|
|
32
|
+
* palette color, default `"black"`).
|
|
33
|
+
* @returns A {@linkcode PluginPresentationAnnotateTextResult} with the created
|
|
34
|
+
* `shapeId`.
|
|
35
|
+
* @throws If Present mode is not open or the sheet id is invalid.
|
|
36
|
+
*
|
|
37
|
+
* @examplePrompt Add a title "Ground Floor" to Sheet 1
|
|
38
|
+
* @examplePrompt Label the cover sheet with the project name
|
|
39
|
+
* @examplePrompt Caption this view with "Proposed layout"
|
|
40
|
+
* @examplePrompt Put a red note on the sheet
|
|
41
|
+
*
|
|
42
|
+
* # Example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const { shapeId } = await snaptrude.presentation.annotate.text(
|
|
45
|
+
* "sheet_1",
|
|
46
|
+
* "Ground Floor",
|
|
47
|
+
* { position: { x: 40, y: 40 }, size: "xl", color: "blue" },
|
|
48
|
+
* )
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
abstract text(sheetId: string, text: string, options?: {
|
|
52
|
+
position?: {
|
|
53
|
+
x: number;
|
|
54
|
+
y: number;
|
|
55
|
+
};
|
|
56
|
+
size?: PluginAnnotateTextSize;
|
|
57
|
+
color?: PluginAnnotateTextColor;
|
|
58
|
+
}): PluginApiReturn<PluginPresentationAnnotateTextResult>;
|
|
59
|
+
/**
|
|
60
|
+
* Draw an arrow on a sheet.
|
|
61
|
+
*
|
|
62
|
+
* Creates an arrow shape from `start` to `end` (both relative to the sheet's
|
|
63
|
+
* top-left, in canvas units — the same Arrow tool as the Present toolbar) and
|
|
64
|
+
* returns the id of the created canvas shape. Requires Present mode to be open.
|
|
65
|
+
*
|
|
66
|
+
* @param sheetId - The sheet to annotate.
|
|
67
|
+
* @param start - Arrow tail position (`{ x, y }`, relative to the sheet's top-left).
|
|
68
|
+
* @param end - Arrow head position (`{ x, y }`, relative to the sheet's top-left).
|
|
69
|
+
* @param options - Optional `color` (a named palette color, default `"black"`)
|
|
70
|
+
* and `size` (stroke weight preset, `"s" | "m" | "l" | "xl"`, default `"m"`).
|
|
71
|
+
* @returns A {@linkcode PluginPresentationAnnotateResult} with the created
|
|
72
|
+
* `shapeId`.
|
|
73
|
+
* @throws If Present mode is not open or the sheet id is invalid.
|
|
74
|
+
*
|
|
75
|
+
* @examplePrompt Draw an arrow pointing at the entrance on Sheet 1
|
|
76
|
+
* @examplePrompt Add a red arrow from the title to the plan view
|
|
77
|
+
* @examplePrompt Point an arrow at the top-left view on the cover sheet
|
|
78
|
+
*
|
|
79
|
+
* # Example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const { shapeId } = await snaptrude.presentation.annotate.arrow(
|
|
82
|
+
* "sheet_1",
|
|
83
|
+
* { x: 100, y: 200 },
|
|
84
|
+
* { x: 300, y: 250 },
|
|
85
|
+
* { color: "red" },
|
|
86
|
+
* )
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
abstract arrow(sheetId: string, start: {
|
|
90
|
+
x: number;
|
|
91
|
+
y: number;
|
|
92
|
+
}, end: {
|
|
93
|
+
x: number;
|
|
94
|
+
y: number;
|
|
95
|
+
}, options?: {
|
|
96
|
+
color?: PluginAnnotateTextColor;
|
|
97
|
+
size?: PluginAnnotateTextSize;
|
|
98
|
+
}): PluginApiReturn<PluginPresentationAnnotateResult>;
|
|
99
|
+
/**
|
|
100
|
+
* Add a sticky note to a sheet.
|
|
101
|
+
*
|
|
102
|
+
* Creates a note shape (the same Note tool as the Present toolbar — a
|
|
103
|
+
* fixed-size sticky square that grows with its text) and returns the id of
|
|
104
|
+
* the created canvas shape. Requires Present mode to be open.
|
|
105
|
+
*
|
|
106
|
+
* @param sheetId - The sheet to annotate.
|
|
107
|
+
* @param text - The note text.
|
|
108
|
+
* @param options - Optional `position` (`{ x, y }`, relative to the sheet's
|
|
109
|
+
* top-left, in canvas units — defaults to the sheet's top-left corner),
|
|
110
|
+
* `color` (a named palette color, default `"black"` — rendered as the
|
|
111
|
+
* note's sticky fill), and `size` (text size preset,
|
|
112
|
+
* `"s" | "m" | "l" | "xl"`, default `"m"`).
|
|
113
|
+
* @returns A {@linkcode PluginPresentationAnnotateResult} with the created
|
|
114
|
+
* `shapeId`.
|
|
115
|
+
* @throws If Present mode is not open or the sheet id is invalid.
|
|
116
|
+
*
|
|
117
|
+
* @examplePrompt Add a sticky note "Review this wall" to Sheet 1
|
|
118
|
+
* @examplePrompt Put a yellow note on the cover sheet
|
|
119
|
+
* @examplePrompt Leave a note next to the ground floor plan
|
|
120
|
+
*
|
|
121
|
+
* # Example
|
|
122
|
+
* ```ts
|
|
123
|
+
* const { shapeId } = await snaptrude.presentation.annotate.note(
|
|
124
|
+
* "sheet_1",
|
|
125
|
+
* "Review this wall",
|
|
126
|
+
* { position: { x: 60, y: 120 }, color: "yellow" },
|
|
127
|
+
* )
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
abstract note(sheetId: string, text: string, options?: {
|
|
131
|
+
position?: {
|
|
132
|
+
x: number;
|
|
133
|
+
y: number;
|
|
134
|
+
};
|
|
135
|
+
color?: PluginAnnotateTextColor;
|
|
136
|
+
size?: PluginAnnotateTextSize;
|
|
137
|
+
}): PluginApiReturn<PluginPresentationAnnotateResult>;
|
|
138
|
+
/**
|
|
139
|
+
* Draw a geo shape (rectangle, ellipse, cloud, …) on a sheet.
|
|
140
|
+
*
|
|
141
|
+
* Creates a geo shape of the given `kind` — the same shapes as the Present
|
|
142
|
+
* toolbar's shape flyout — sized to `bounds` (relative to the sheet's
|
|
143
|
+
* top-left, in canvas units) and returns the id of the created canvas shape.
|
|
144
|
+
* Requires Present mode to be open.
|
|
145
|
+
*
|
|
146
|
+
* @param sheetId - The sheet to annotate.
|
|
147
|
+
* @param kind - The shape kind ({@linkcode PluginAnnotateGeoKind}), e.g.
|
|
148
|
+
* `"rectangle"`, `"ellipse"`, `"cloud"`.
|
|
149
|
+
* @param bounds - Placement box `{ x, y, w, h }` — `x`/`y` are the shape's
|
|
150
|
+
* top-left relative to the sheet's top-left; `w`/`h` must be positive.
|
|
151
|
+
* @param options - Optional `color` (a named palette color, default
|
|
152
|
+
* `"black"`) and `fill` ({@linkcode PluginAnnotateFill}, default `"none"` —
|
|
153
|
+
* outline only).
|
|
154
|
+
* @returns A {@linkcode PluginPresentationAnnotateResult} with the created
|
|
155
|
+
* `shapeId`.
|
|
156
|
+
* @throws If Present mode is not open or the sheet id is invalid.
|
|
157
|
+
*
|
|
158
|
+
* @examplePrompt Draw a revision cloud around the kitchen on Sheet 2
|
|
159
|
+
* @examplePrompt Add a red rectangle highlight to the sheet
|
|
160
|
+
* @examplePrompt Draw an ellipse around the entrance on the cover sheet
|
|
161
|
+
*
|
|
162
|
+
* # Example
|
|
163
|
+
* ```ts
|
|
164
|
+
* const { shapeId } = await snaptrude.presentation.annotate.shape(
|
|
165
|
+
* "sheet_1",
|
|
166
|
+
* "cloud",
|
|
167
|
+
* { x: 80, y: 80, w: 240, h: 160 },
|
|
168
|
+
* { color: "red" },
|
|
169
|
+
* )
|
|
170
|
+
* ```
|
|
171
|
+
*/
|
|
172
|
+
abstract shape(sheetId: string, kind: PluginAnnotateGeoKind, bounds: {
|
|
173
|
+
x: number;
|
|
174
|
+
y: number;
|
|
175
|
+
w: number;
|
|
176
|
+
h: number;
|
|
177
|
+
}, options?: {
|
|
178
|
+
color?: PluginAnnotateTextColor;
|
|
179
|
+
fill?: PluginAnnotateFill;
|
|
180
|
+
}): PluginApiReturn<PluginPresentationAnnotateResult>;
|
|
181
|
+
}
|
|
182
|
+
/** Text size preset (the same s/m/l/xl scale as the Present-mode text tool). */
|
|
183
|
+
export declare const PluginAnnotateTextSize: z.ZodEnum<{
|
|
184
|
+
m: "m";
|
|
185
|
+
s: "s";
|
|
186
|
+
l: "l";
|
|
187
|
+
xl: "xl";
|
|
188
|
+
}>;
|
|
189
|
+
export type PluginAnnotateTextSize = z.infer<typeof PluginAnnotateTextSize>;
|
|
190
|
+
/** Named palette color (the same swatches as the Present-mode style panel). */
|
|
191
|
+
export declare const PluginAnnotateTextColor: z.ZodEnum<{
|
|
192
|
+
black: "black";
|
|
193
|
+
grey: "grey";
|
|
194
|
+
"light-violet": "light-violet";
|
|
195
|
+
violet: "violet";
|
|
196
|
+
blue: "blue";
|
|
197
|
+
"light-blue": "light-blue";
|
|
198
|
+
yellow: "yellow";
|
|
199
|
+
orange: "orange";
|
|
200
|
+
green: "green";
|
|
201
|
+
"light-green": "light-green";
|
|
202
|
+
"light-red": "light-red";
|
|
203
|
+
red: "red";
|
|
204
|
+
white: "white";
|
|
205
|
+
}>;
|
|
206
|
+
export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>;
|
|
207
|
+
/**
|
|
208
|
+
* Arguments for {@linkcode PluginPresentationAnnotateApi.text}.
|
|
209
|
+
*
|
|
210
|
+
* | Property | Type | Description |
|
|
211
|
+
* |---|---|---|
|
|
212
|
+
* | `sheetId` | `string` | The sheet to annotate |
|
|
213
|
+
* | `text` | `string` | The label text |
|
|
214
|
+
* | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
|
|
215
|
+
* | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
|
|
216
|
+
* | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Text color |
|
|
217
|
+
*/
|
|
218
|
+
export declare const PluginPresentationAnnotateTextArgs: z.ZodObject<{
|
|
219
|
+
sheetId: z.ZodString;
|
|
220
|
+
text: z.ZodString;
|
|
221
|
+
position: z.ZodOptional<z.ZodObject<{
|
|
222
|
+
x: z.ZodNumber;
|
|
223
|
+
y: z.ZodNumber;
|
|
224
|
+
}, z.core.$strip>>;
|
|
225
|
+
size: z.ZodOptional<z.ZodEnum<{
|
|
226
|
+
m: "m";
|
|
227
|
+
s: "s";
|
|
228
|
+
l: "l";
|
|
229
|
+
xl: "xl";
|
|
230
|
+
}>>;
|
|
231
|
+
color: z.ZodOptional<z.ZodEnum<{
|
|
232
|
+
black: "black";
|
|
233
|
+
grey: "grey";
|
|
234
|
+
"light-violet": "light-violet";
|
|
235
|
+
violet: "violet";
|
|
236
|
+
blue: "blue";
|
|
237
|
+
"light-blue": "light-blue";
|
|
238
|
+
yellow: "yellow";
|
|
239
|
+
orange: "orange";
|
|
240
|
+
green: "green";
|
|
241
|
+
"light-green": "light-green";
|
|
242
|
+
"light-red": "light-red";
|
|
243
|
+
red: "red";
|
|
244
|
+
white: "white";
|
|
245
|
+
}>>;
|
|
246
|
+
}, z.core.$strip>;
|
|
247
|
+
export type PluginPresentationAnnotateTextArgs = z.infer<typeof PluginPresentationAnnotateTextArgs>;
|
|
248
|
+
/**
|
|
249
|
+
* Result of {@linkcode PluginPresentationAnnotateApi.text}.
|
|
250
|
+
*
|
|
251
|
+
* | Property | Type | Description |
|
|
252
|
+
* |---|---|---|
|
|
253
|
+
* | `shapeId` | `string` | Id of the created text shape |
|
|
254
|
+
*/
|
|
255
|
+
export declare const PluginPresentationAnnotateTextResult: z.ZodObject<{
|
|
256
|
+
shapeId: z.ZodString;
|
|
257
|
+
}, z.core.$strip>;
|
|
258
|
+
export type PluginPresentationAnnotateTextResult = z.infer<typeof PluginPresentationAnnotateTextResult>;
|
|
259
|
+
/**
|
|
260
|
+
* Geo shape kind — the shapes offered by the Present-mode toolbar's shape
|
|
261
|
+
* flyout.
|
|
262
|
+
*/
|
|
263
|
+
export declare const PluginAnnotateGeoKind: z.ZodEnum<{
|
|
264
|
+
rectangle: "rectangle";
|
|
265
|
+
ellipse: "ellipse";
|
|
266
|
+
triangle: "triangle";
|
|
267
|
+
diamond: "diamond";
|
|
268
|
+
hexagon: "hexagon";
|
|
269
|
+
oval: "oval";
|
|
270
|
+
rhombus: "rhombus";
|
|
271
|
+
star: "star";
|
|
272
|
+
cloud: "cloud";
|
|
273
|
+
heart: "heart";
|
|
274
|
+
"x-box": "x-box";
|
|
275
|
+
"check-box": "check-box";
|
|
276
|
+
"arrow-left": "arrow-left";
|
|
277
|
+
"arrow-up": "arrow-up";
|
|
278
|
+
"arrow-right": "arrow-right";
|
|
279
|
+
"arrow-down": "arrow-down";
|
|
280
|
+
}>;
|
|
281
|
+
export type PluginAnnotateGeoKind = z.infer<typeof PluginAnnotateGeoKind>;
|
|
282
|
+
/** Fill style for geo shapes (the same fills as the Present-mode style panel). */
|
|
283
|
+
export declare const PluginAnnotateFill: z.ZodEnum<{
|
|
284
|
+
pattern: "pattern";
|
|
285
|
+
none: "none";
|
|
286
|
+
semi: "semi";
|
|
287
|
+
solid: "solid";
|
|
288
|
+
}>;
|
|
289
|
+
export type PluginAnnotateFill = z.infer<typeof PluginAnnotateFill>;
|
|
290
|
+
/**
|
|
291
|
+
* Arguments for {@linkcode PluginPresentationAnnotateApi.arrow}.
|
|
292
|
+
*
|
|
293
|
+
* | Property | Type | Description |
|
|
294
|
+
* |---|---|---|
|
|
295
|
+
* | `sheetId` | `string` | The sheet to annotate |
|
|
296
|
+
* | `start` | `{ x: number; y: number }` | Arrow tail (relative to the sheet) |
|
|
297
|
+
* | `end` | `{ x: number; y: number }` | Arrow head (relative to the sheet) |
|
|
298
|
+
* | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Arrow color |
|
|
299
|
+
* | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Stroke weight preset |
|
|
300
|
+
*/
|
|
301
|
+
export declare const PluginPresentationAnnotateArrowArgs: z.ZodObject<{
|
|
302
|
+
sheetId: z.ZodString;
|
|
303
|
+
start: z.ZodObject<{
|
|
304
|
+
x: z.ZodNumber;
|
|
305
|
+
y: z.ZodNumber;
|
|
306
|
+
}, z.core.$strip>;
|
|
307
|
+
end: z.ZodObject<{
|
|
308
|
+
x: z.ZodNumber;
|
|
309
|
+
y: z.ZodNumber;
|
|
310
|
+
}, z.core.$strip>;
|
|
311
|
+
color: z.ZodOptional<z.ZodEnum<{
|
|
312
|
+
black: "black";
|
|
313
|
+
grey: "grey";
|
|
314
|
+
"light-violet": "light-violet";
|
|
315
|
+
violet: "violet";
|
|
316
|
+
blue: "blue";
|
|
317
|
+
"light-blue": "light-blue";
|
|
318
|
+
yellow: "yellow";
|
|
319
|
+
orange: "orange";
|
|
320
|
+
green: "green";
|
|
321
|
+
"light-green": "light-green";
|
|
322
|
+
"light-red": "light-red";
|
|
323
|
+
red: "red";
|
|
324
|
+
white: "white";
|
|
325
|
+
}>>;
|
|
326
|
+
size: z.ZodOptional<z.ZodEnum<{
|
|
327
|
+
m: "m";
|
|
328
|
+
s: "s";
|
|
329
|
+
l: "l";
|
|
330
|
+
xl: "xl";
|
|
331
|
+
}>>;
|
|
332
|
+
}, z.core.$strip>;
|
|
333
|
+
export type PluginPresentationAnnotateArrowArgs = z.infer<typeof PluginPresentationAnnotateArrowArgs>;
|
|
334
|
+
/**
|
|
335
|
+
* Arguments for {@linkcode PluginPresentationAnnotateApi.note}.
|
|
336
|
+
*
|
|
337
|
+
* | Property | Type | Description |
|
|
338
|
+
* |---|---|---|
|
|
339
|
+
* | `sheetId` | `string` | The sheet to annotate |
|
|
340
|
+
* | `text` | `string` | The note text |
|
|
341
|
+
* | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
|
|
342
|
+
* | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Sticky fill color |
|
|
343
|
+
* | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
|
|
344
|
+
*/
|
|
345
|
+
export declare const PluginPresentationAnnotateNoteArgs: z.ZodObject<{
|
|
346
|
+
sheetId: z.ZodString;
|
|
347
|
+
text: z.ZodString;
|
|
348
|
+
position: z.ZodOptional<z.ZodObject<{
|
|
349
|
+
x: z.ZodNumber;
|
|
350
|
+
y: z.ZodNumber;
|
|
351
|
+
}, z.core.$strip>>;
|
|
352
|
+
color: z.ZodOptional<z.ZodEnum<{
|
|
353
|
+
black: "black";
|
|
354
|
+
grey: "grey";
|
|
355
|
+
"light-violet": "light-violet";
|
|
356
|
+
violet: "violet";
|
|
357
|
+
blue: "blue";
|
|
358
|
+
"light-blue": "light-blue";
|
|
359
|
+
yellow: "yellow";
|
|
360
|
+
orange: "orange";
|
|
361
|
+
green: "green";
|
|
362
|
+
"light-green": "light-green";
|
|
363
|
+
"light-red": "light-red";
|
|
364
|
+
red: "red";
|
|
365
|
+
white: "white";
|
|
366
|
+
}>>;
|
|
367
|
+
size: z.ZodOptional<z.ZodEnum<{
|
|
368
|
+
m: "m";
|
|
369
|
+
s: "s";
|
|
370
|
+
l: "l";
|
|
371
|
+
xl: "xl";
|
|
372
|
+
}>>;
|
|
373
|
+
}, z.core.$strip>;
|
|
374
|
+
export type PluginPresentationAnnotateNoteArgs = z.infer<typeof PluginPresentationAnnotateNoteArgs>;
|
|
375
|
+
/**
|
|
376
|
+
* Arguments for {@linkcode PluginPresentationAnnotateApi.shape}.
|
|
377
|
+
*
|
|
378
|
+
* | Property | Type | Description |
|
|
379
|
+
* |---|---|---|
|
|
380
|
+
* | `sheetId` | `string` | The sheet to annotate |
|
|
381
|
+
* | `kind` | {@linkcode PluginAnnotateGeoKind} | The shape kind |
|
|
382
|
+
* | `bounds` | `{ x: number; y: number; w: number; h: number }` | Placement box (relative to the sheet; `w`/`h` positive) |
|
|
383
|
+
* | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Outline color |
|
|
384
|
+
* | `fill` | {@linkcode PluginAnnotateFill}` \| undefined` | Fill style |
|
|
385
|
+
*/
|
|
386
|
+
export declare const PluginPresentationAnnotateShapeArgs: z.ZodObject<{
|
|
387
|
+
sheetId: z.ZodString;
|
|
388
|
+
kind: z.ZodEnum<{
|
|
389
|
+
rectangle: "rectangle";
|
|
390
|
+
ellipse: "ellipse";
|
|
391
|
+
triangle: "triangle";
|
|
392
|
+
diamond: "diamond";
|
|
393
|
+
hexagon: "hexagon";
|
|
394
|
+
oval: "oval";
|
|
395
|
+
rhombus: "rhombus";
|
|
396
|
+
star: "star";
|
|
397
|
+
cloud: "cloud";
|
|
398
|
+
heart: "heart";
|
|
399
|
+
"x-box": "x-box";
|
|
400
|
+
"check-box": "check-box";
|
|
401
|
+
"arrow-left": "arrow-left";
|
|
402
|
+
"arrow-up": "arrow-up";
|
|
403
|
+
"arrow-right": "arrow-right";
|
|
404
|
+
"arrow-down": "arrow-down";
|
|
405
|
+
}>;
|
|
406
|
+
bounds: z.ZodObject<{
|
|
407
|
+
x: z.ZodNumber;
|
|
408
|
+
y: z.ZodNumber;
|
|
409
|
+
w: z.ZodNumber;
|
|
410
|
+
h: z.ZodNumber;
|
|
411
|
+
}, z.core.$strip>;
|
|
412
|
+
color: z.ZodOptional<z.ZodEnum<{
|
|
413
|
+
black: "black";
|
|
414
|
+
grey: "grey";
|
|
415
|
+
"light-violet": "light-violet";
|
|
416
|
+
violet: "violet";
|
|
417
|
+
blue: "blue";
|
|
418
|
+
"light-blue": "light-blue";
|
|
419
|
+
yellow: "yellow";
|
|
420
|
+
orange: "orange";
|
|
421
|
+
green: "green";
|
|
422
|
+
"light-green": "light-green";
|
|
423
|
+
"light-red": "light-red";
|
|
424
|
+
red: "red";
|
|
425
|
+
white: "white";
|
|
426
|
+
}>>;
|
|
427
|
+
fill: z.ZodOptional<z.ZodEnum<{
|
|
428
|
+
pattern: "pattern";
|
|
429
|
+
none: "none";
|
|
430
|
+
semi: "semi";
|
|
431
|
+
solid: "solid";
|
|
432
|
+
}>>;
|
|
433
|
+
}, z.core.$strip>;
|
|
434
|
+
export type PluginPresentationAnnotateShapeArgs = z.infer<typeof PluginPresentationAnnotateShapeArgs>;
|
|
435
|
+
/**
|
|
436
|
+
* Result of {@linkcode PluginPresentationAnnotateApi.arrow},
|
|
437
|
+
* {@linkcode PluginPresentationAnnotateApi.note}, and
|
|
438
|
+
* {@linkcode PluginPresentationAnnotateApi.shape}.
|
|
439
|
+
*
|
|
440
|
+
* | Property | Type | Description |
|
|
441
|
+
* |---|---|---|
|
|
442
|
+
* | `shapeId` | `string` | Id of the created canvas shape |
|
|
443
|
+
*/
|
|
444
|
+
export declare const PluginPresentationAnnotateResult: z.ZodObject<{
|
|
445
|
+
shapeId: z.ZodString;
|
|
446
|
+
}, z.core.$strip>;
|
|
447
|
+
export type PluginPresentationAnnotateResult = z.infer<typeof PluginPresentationAnnotateResult>;
|
|
448
|
+
//# sourceMappingURL=annotate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/annotate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,6BAA6B;;IAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,IAAI,CAAC,EAAE,sBAAsB,CAAA;QAC7B,KAAK,CAAC,EAAE,uBAAuB,CAAA;KAChC,GACA,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC/B,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC7B,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;KAC9B,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;KAC9B,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,qBAAqB,EAC3B,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,kBAAkB,CAAA;KAC1B,GACA,eAAe,CAAC,gCAAgC,CAAC;CACrD;AAED,gFAAgF;AAChF,eAAO,MAAM,sBAAsB;;;;;EAAgC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;EAclC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM7C,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;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;EAiBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,kFAAkF;AAClF,eAAO,MAAM,kBAAkB;;;;;EAA+C,CAAA;AAC9E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}
|
|
@@ -1,22 +1,52 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
2
|
import { PluginApiReturn } from "../../types";
|
|
3
3
|
/**
|
|
4
|
-
* Presentation diagrams —
|
|
4
|
+
* Presentation diagrams — generate program diagrams from the model, and place
|
|
5
|
+
* diagram images onto sheets.
|
|
5
6
|
*
|
|
6
|
-
* {@linkcode PluginPresentationDiagramsApi.
|
|
7
|
-
*
|
|
8
|
-
*
|
|
7
|
+
* {@linkcode PluginPresentationDiagramsApi.generateProgram} runs the Present-mode
|
|
8
|
+
* **Program** action: it reads the project's spaces and departments and creates
|
|
9
|
+
* new layout sheets holding the generated diagram graphics.
|
|
10
|
+
* {@linkcode PluginPresentationDiagramsApi.place} drops ready diagram images (by
|
|
11
|
+
* URL) onto an existing sheet and returns the created canvas shape ids. Both
|
|
12
|
+
* require Present mode to be open. Adjacency data itself is read and computed via
|
|
9
13
|
* `program.adjacency` (see {@linkcode PluginProgramAdjacencyApi}).
|
|
10
14
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
+
* There is intentionally no `generateAdjacency`: the host's adjacency generator
|
|
16
|
+
* runs its sheet-creation task fire-and-forget internally, so a single call
|
|
17
|
+
* cannot return the sheets it creates. Use the Present-mode Adjacency menu for
|
|
18
|
+
* those, then `place` a pre-rendered adjacency image if you need it via the API.
|
|
15
19
|
*
|
|
16
20
|
* Accessed via `snaptrude.presentation.diagrams`.
|
|
17
21
|
*/
|
|
18
22
|
export declare abstract class PluginPresentationDiagramsApi {
|
|
19
23
|
constructor();
|
|
24
|
+
/**
|
|
25
|
+
* Generate the program (space + department) diagrams for the current model,
|
|
26
|
+
* creating new layout sheets.
|
|
27
|
+
*
|
|
28
|
+
* Runs the same auto-generation as the Present-mode **Program** action: reads
|
|
29
|
+
* the project's spaces and departments, lays them out to scale, and creates one
|
|
30
|
+
* or more new sheets holding the generated diagram graphics. Unlike
|
|
31
|
+
* {@linkcode PluginPresentationDiagramsApi.place} (which pastes ready image URLs
|
|
32
|
+
* onto an existing sheet), this generates the graphics from the model and
|
|
33
|
+
* creates its own sheets. Requires Present mode to be open.
|
|
34
|
+
*
|
|
35
|
+
* @returns A {@linkcode PluginPresentationDiagramsGenerateResult} with the
|
|
36
|
+
* `sheetIds` of the sheets created.
|
|
37
|
+
* @throws If Present mode is not open, or the model has no spaces/departments to
|
|
38
|
+
* generate from.
|
|
39
|
+
*
|
|
40
|
+
* @examplePrompt Generate the program diagrams for this project
|
|
41
|
+
* @examplePrompt Auto-generate the space and department diagram sheets
|
|
42
|
+
* @examplePrompt Create the program layout sheets from the model
|
|
43
|
+
*
|
|
44
|
+
* # Example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const { sheetIds } = await snaptrude.presentation.diagrams.generateProgram()
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
abstract generateProgram(): PluginApiReturn<PluginPresentationDiagramsGenerateResult>;
|
|
20
50
|
/**
|
|
21
51
|
* Place diagram images onto a sheet.
|
|
22
52
|
*
|
|
@@ -78,4 +108,15 @@ export declare const PluginPresentationDiagramsPlaceResult: z.ZodObject<{
|
|
|
78
108
|
shapeIds: z.ZodArray<z.ZodString>;
|
|
79
109
|
}, z.core.$strip>;
|
|
80
110
|
export type PluginPresentationDiagramsPlaceResult = z.infer<typeof PluginPresentationDiagramsPlaceResult>;
|
|
111
|
+
/**
|
|
112
|
+
* Result of {@linkcode PluginPresentationDiagramsApi.generateProgram}.
|
|
113
|
+
*
|
|
114
|
+
* | Property | Type | Description |
|
|
115
|
+
* |---|---|---|
|
|
116
|
+
* | `sheetIds` | `string[]` | Ids of the sheets created by the generator |
|
|
117
|
+
*/
|
|
118
|
+
export declare const PluginPresentationDiagramsGenerateResult: z.ZodObject<{
|
|
119
|
+
sheetIds: z.ZodArray<z.ZodString>;
|
|
120
|
+
}, z.core.$strip>;
|
|
121
|
+
export type PluginPresentationDiagramsGenerateResult = z.infer<typeof PluginPresentationDiagramsGenerateResult>;
|
|
81
122
|
//# sourceMappingURL=diagrams.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"diagrams.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/diagrams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C
|
|
1
|
+
{"version":3,"file":"diagrams.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/diagrams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,6BAA6B;;IAGjD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,eAAe,IAAI,eAAe,CAAC,wCAAwC,CAAC;IAE5F;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,eAAe,CAAC,qCAAqC,CAAC;CAC1D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;iBAI9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wCAAwC;;iBAEnD,CAAA;AACF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA"}
|