@imgly/codesign-mcp 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (973) hide show
  1. package/README.md +51 -1
  2. package/assets/docs/guide/SKILL.md +45 -53
  3. package/assets/docs/guide/animation/create/base.md +234 -243
  4. package/assets/docs/guide/animation/create/text.md +250 -231
  5. package/assets/docs/guide/animation/create.md +197 -231
  6. package/assets/docs/guide/animation/edit.md +196 -271
  7. package/assets/docs/guide/animation/types.md +182 -185
  8. package/assets/docs/guide/animation.md +9 -6
  9. package/assets/docs/guide/api/AssetAPI.md +7 -53
  10. package/assets/docs/guide/api/BlockAPI.md +725 -648
  11. package/assets/docs/guide/api/CreativeEngine.md +7 -16
  12. package/assets/docs/guide/api/EditorAPI.md +32 -93
  13. package/assets/docs/guide/api/EventAPI.md +1 -2
  14. package/assets/docs/guide/api/SceneAPI.md +47 -98
  15. package/assets/docs/guide/api/VariableAPI.md +1 -4
  16. package/assets/docs/guide/api/node/classes/assetapi.md +1090 -0
  17. package/assets/docs/guide/api/node/classes/blockapi.md +12965 -0
  18. package/assets/docs/guide/api/node/classes/creativeengine.md +319 -0
  19. package/assets/docs/guide/api/node/classes/editorapi.md +3417 -0
  20. package/assets/docs/guide/api/node/classes/engineactions.md +319 -0
  21. package/assets/docs/guide/api/node/classes/eventapi.md +56 -0
  22. package/assets/docs/guide/api/node/classes/sceneapi.md +1370 -0
  23. package/assets/docs/guide/api/node/classes/variableapi.md +143 -0
  24. package/assets/docs/guide/api/node/enumerations/compressionformat.md +23 -0
  25. package/assets/docs/guide/api/node/enumerations/compressionlevel.md +24 -0
  26. package/assets/docs/guide/api/node/functions/iscmykcolor.md +30 -0
  27. package/assets/docs/guide/api/node/functions/isrgbacolor.md +30 -0
  28. package/assets/docs/guide/api/node/functions/isspotcolor.md +30 -0
  29. package/assets/docs/guide/api/node/interfaces/addvideooptions.md +31 -0
  30. package/assets/docs/guide/api/node/interfaces/applyassetoptions.md +31 -0
  31. package/assets/docs/guide/api/node/interfaces/asset.md +30 -0
  32. package/assets/docs/guide/api/node/interfaces/assetbooleanproperty.md +25 -0
  33. package/assets/docs/guide/api/node/interfaces/assetcmykcolor.md +26 -0
  34. package/assets/docs/guide/api/node/interfaces/assetcolorproperty.md +25 -0
  35. package/assets/docs/guide/api/node/interfaces/assetcontentaspectratio.md +23 -0
  36. package/assets/docs/guide/api/node/interfaces/assetdefinition.md +31 -0
  37. package/assets/docs/guide/api/node/interfaces/assetenumproperty.md +26 -0
  38. package/assets/docs/guide/api/node/interfaces/assetfixedaspectratio.md +24 -0
  39. package/assets/docs/guide/api/node/interfaces/assetfixedsize.md +25 -0
  40. package/assets/docs/guide/api/node/interfaces/assetfreeaspectratio.md +22 -0
  41. package/assets/docs/guide/api/node/interfaces/assetnumberproperty.md +28 -0
  42. package/assets/docs/guide/api/node/interfaces/assetpayload.md +27 -0
  43. package/assets/docs/guide/api/node/interfaces/assetquerydata.md +32 -0
  44. package/assets/docs/guide/api/node/interfaces/assetresult.md +46 -0
  45. package/assets/docs/guide/api/node/interfaces/assetrgbcolor.md +25 -0
  46. package/assets/docs/guide/api/node/interfaces/assetsource.md +111 -0
  47. package/assets/docs/guide/api/node/interfaces/assetspotcolor.md +25 -0
  48. package/assets/docs/guide/api/node/interfaces/assetsqueryresult.md +31 -0
  49. package/assets/docs/guide/api/node/interfaces/assetstringproperty.md +25 -0
  50. package/assets/docs/guide/api/node/interfaces/assetstylepreset.md +39 -0
  51. package/assets/docs/guide/api/node/interfaces/assetstylepresetanimation.md +23 -0
  52. package/assets/docs/guide/api/node/interfaces/audiotrackinfo.md +32 -0
  53. package/assets/docs/guide/api/node/interfaces/blockevent.md +26 -0
  54. package/assets/docs/guide/api/node/interfaces/blockstateerror.md +26 -0
  55. package/assets/docs/guide/api/node/interfaces/blockstatepending.md +26 -0
  56. package/assets/docs/guide/api/node/interfaces/blockstateready.md +25 -0
  57. package/assets/docs/guide/api/node/interfaces/buffer.md +26 -0
  58. package/assets/docs/guide/api/node/interfaces/characterinkbox.md +29 -0
  59. package/assets/docs/guide/api/node/interfaces/cmykcolor.md +34 -0
  60. package/assets/docs/guide/api/node/interfaces/completeassetresult.md +46 -0
  61. package/assets/docs/guide/api/node/interfaces/configuration.md +38 -0
  62. package/assets/docs/guide/api/node/interfaces/dominantcolor.md +25 -0
  63. package/assets/docs/guide/api/node/interfaces/dominantcolorsoptions.md +23 -0
  64. package/assets/docs/guide/api/node/interfaces/engineactioninfo.md +24 -0
  65. package/assets/docs/guide/api/node/interfaces/engineactionsregistry.md +18 -0
  66. package/assets/docs/guide/api/node/interfaces/engineplugin.md +30 -0
  67. package/assets/docs/guide/api/node/interfaces/font.md +27 -0
  68. package/assets/docs/guide/api/node/interfaces/fontmetrics.md +32 -0
  69. package/assets/docs/guide/api/node/interfaces/gradientcolorstop.md +28 -0
  70. package/assets/docs/guide/api/node/interfaces/logger.md +39 -0
  71. package/assets/docs/guide/api/node/interfaces/pageduration.md +23 -0
  72. package/assets/docs/guide/api/node/interfaces/range.md +23 -0
  73. package/assets/docs/guide/api/node/interfaces/rgbacolor.md +32 -0
  74. package/assets/docs/guide/api/node/interfaces/rgbcolor.md +30 -0
  75. package/assets/docs/guide/api/node/interfaces/settings.md +126 -0
  76. package/assets/docs/guide/api/node/interfaces/size2.md +21 -0
  77. package/assets/docs/guide/api/node/interfaces/source.md +24 -0
  78. package/assets/docs/guide/api/node/interfaces/spotcolor.md +30 -0
  79. package/assets/docs/guide/api/node/interfaces/textdecorationconfig.md +31 -0
  80. package/assets/docs/guide/api/node/interfaces/textfontsizeoptions.md +24 -0
  81. package/assets/docs/guide/api/node/interfaces/textruninfo.md +33 -0
  82. package/assets/docs/guide/api/node/interfaces/transientresource.md +26 -0
  83. package/assets/docs/guide/api/node/interfaces/typeface.md +23 -0
  84. package/assets/docs/guide/api/node/interfaces/vec2.md +21 -0
  85. package/assets/docs/guide/api/node/interfaces/vec3.md +22 -0
  86. package/assets/docs/guide/api/node/type-aliases/addimageoptions.md +36 -0
  87. package/assets/docs/guide/api/node/type-aliases/animationbaselinedirection.md +18 -0
  88. package/assets/docs/guide/api/node/type-aliases/animationblockswipetextdirection.md +18 -0
  89. package/assets/docs/guide/api/node/type-aliases/animationeasing.md +18 -0
  90. package/assets/docs/guide/api/node/type-aliases/animationentry.md +28 -0
  91. package/assets/docs/guide/api/node/type-aliases/animationgrowdirection.md +18 -0
  92. package/assets/docs/guide/api/node/type-aliases/animationjumploopdirection.md +18 -0
  93. package/assets/docs/guide/api/node/type-aliases/animationkenburnsdirection.md +18 -0
  94. package/assets/docs/guide/api/node/type-aliases/animationmergetextdirection.md +18 -0
  95. package/assets/docs/guide/api/node/type-aliases/animationoptions.md +28 -0
  96. package/assets/docs/guide/api/node/type-aliases/animationspindirection.md +18 -0
  97. package/assets/docs/guide/api/node/type-aliases/animationspinloopdirection.md +18 -0
  98. package/assets/docs/guide/api/node/type-aliases/animationtype.md +24 -0
  99. package/assets/docs/guide/api/node/type-aliases/animationtypelonghand.md +21 -0
  100. package/assets/docs/guide/api/node/type-aliases/animationtypeshorthand.md +18 -0
  101. package/assets/docs/guide/api/node/type-aliases/animationtypewritertextwritingstyle.md +18 -0
  102. package/assets/docs/guide/api/node/type-aliases/animationwipedirection.md +18 -0
  103. package/assets/docs/guide/api/node/type-aliases/applicationmimetype.md +20 -0
  104. package/assets/docs/guide/api/node/type-aliases/assetcolor.md +23 -0
  105. package/assets/docs/guide/api/node/type-aliases/assetfilter.md +47 -0
  106. package/assets/docs/guide/api/node/type-aliases/assetgroups.md +25 -0
  107. package/assets/docs/guide/api/node/type-aliases/assetmetadata.md +42 -0
  108. package/assets/docs/guide/api/node/type-aliases/assetproperty.md +25 -0
  109. package/assets/docs/guide/api/node/type-aliases/assetpropertyfilter.md +41 -0
  110. package/assets/docs/guide/api/node/type-aliases/assetpropertypath.md +26 -0
  111. package/assets/docs/guide/api/node/type-aliases/assetstylepresetanimationproperties.md +34 -0
  112. package/assets/docs/guide/api/node/type-aliases/assetstylepresetproperties.md +29 -0
  113. package/assets/docs/guide/api/node/type-aliases/assetstylepresetpropertyvalue.md +29 -0
  114. package/assets/docs/guide/api/node/type-aliases/assetstylepresetscalableproperty.md +28 -0
  115. package/assets/docs/guide/api/node/type-aliases/assettransformpreset.md +24 -0
  116. package/assets/docs/guide/api/node/type-aliases/asyncuriresolver.md +36 -0
  117. package/assets/docs/guide/api/node/type-aliases/audioexportoptions.md +43 -0
  118. package/assets/docs/guide/api/node/type-aliases/audiofromvideooptions.md +27 -0
  119. package/assets/docs/guide/api/node/type-aliases/audiomimetype.md +20 -0
  120. package/assets/docs/guide/api/node/type-aliases/blendmode.md +18 -0
  121. package/assets/docs/guide/api/node/type-aliases/blockenumtype.md +63 -0
  122. package/assets/docs/guide/api/node/type-aliases/blockstate.md +26 -0
  123. package/assets/docs/guide/api/node/type-aliases/blurtype.md +24 -0
  124. package/assets/docs/guide/api/node/type-aliases/blurtypelonghand.md +21 -0
  125. package/assets/docs/guide/api/node/type-aliases/blurtypeshorthand.md +18 -0
  126. package/assets/docs/guide/api/node/type-aliases/booleanoperation.md +27 -0
  127. package/assets/docs/guide/api/node/type-aliases/boolpropertyname.md +79 -0
  128. package/assets/docs/guide/api/node/type-aliases/cameraclampingovershootmode.md +18 -0
  129. package/assets/docs/guide/api/node/type-aliases/captionhorizontalalignment.md +18 -0
  130. package/assets/docs/guide/api/node/type-aliases/captionverticalalignment.md +18 -0
  131. package/assets/docs/guide/api/node/type-aliases/cmyk.md +23 -0
  132. package/assets/docs/guide/api/node/type-aliases/color.md +23 -0
  133. package/assets/docs/guide/api/node/type-aliases/colorpickercolormode.md +18 -0
  134. package/assets/docs/guide/api/node/type-aliases/colorpropertyname.md +31 -0
  135. package/assets/docs/guide/api/node/type-aliases/colorspace.md +20 -0
  136. package/assets/docs/guide/api/node/type-aliases/contentfillmode.md +18 -0
  137. package/assets/docs/guide/api/node/type-aliases/controlgizmomovehandlevisibility.md +18 -0
  138. package/assets/docs/guide/api/node/type-aliases/controlgizmoresizehandlesvisibility.md +18 -0
  139. package/assets/docs/guide/api/node/type-aliases/controlgizmorotatehandlesvisibility.md +18 -0
  140. package/assets/docs/guide/api/node/type-aliases/controlgizmoscalehandlesvisibility.md +18 -0
  141. package/assets/docs/guide/api/node/type-aliases/createsceneoptions.md +30 -0
  142. package/assets/docs/guide/api/node/type-aliases/cutoutoperation.md +20 -0
  143. package/assets/docs/guide/api/node/type-aliases/cutouttype.md +18 -0
  144. package/assets/docs/guide/api/node/type-aliases/defaultassetsourceid.md +37 -0
  145. package/assets/docs/guide/api/node/type-aliases/demoassetsourceid.md +33 -0
  146. package/assets/docs/guide/api/node/type-aliases/designblockid.md +20 -0
  147. package/assets/docs/guide/api/node/type-aliases/designblocktype.md +24 -0
  148. package/assets/docs/guide/api/node/type-aliases/designblocktypelonghand.md +21 -0
  149. package/assets/docs/guide/api/node/type-aliases/designblocktypeshorthand.md +18 -0
  150. package/assets/docs/guide/api/node/type-aliases/designunit.md +18 -0
  151. package/assets/docs/guide/api/node/type-aliases/doubleclickselectionmode.md +18 -0
  152. package/assets/docs/guide/api/node/type-aliases/doublepropertyname.md +26 -0
  153. package/assets/docs/guide/api/node/type-aliases/dropshadowoptions.md +32 -0
  154. package/assets/docs/guide/api/node/type-aliases/editmode.md +27 -0
  155. package/assets/docs/guide/api/node/type-aliases/effecttype.md +24 -0
  156. package/assets/docs/guide/api/node/type-aliases/effecttypelonghand.md +21 -0
  157. package/assets/docs/guide/api/node/type-aliases/effecttypeshorthand.md +18 -0
  158. package/assets/docs/guide/api/node/type-aliases/engineactionid.md +20 -0
  159. package/assets/docs/guide/api/node/type-aliases/enginecustomactionfunction.md +30 -0
  160. package/assets/docs/guide/api/node/type-aliases/engineplugincontext.md +30 -0
  161. package/assets/docs/guide/api/node/type-aliases/enumpropertyname.md +59 -0
  162. package/assets/docs/guide/api/node/type-aliases/enumvalues.md +59 -0
  163. package/assets/docs/guide/api/node/type-aliases/exportoptions.md +57 -0
  164. package/assets/docs/guide/api/node/type-aliases/fillpixelstreamorientation.md +18 -0
  165. package/assets/docs/guide/api/node/type-aliases/filltype.md +24 -0
  166. package/assets/docs/guide/api/node/type-aliases/filltypelonghand.md +21 -0
  167. package/assets/docs/guide/api/node/type-aliases/filltypeshorthand.md +18 -0
  168. package/assets/docs/guide/api/node/type-aliases/floatpropertyname.md +184 -0
  169. package/assets/docs/guide/api/node/type-aliases/fontsizeunit.md +23 -0
  170. package/assets/docs/guide/api/node/type-aliases/fontstyle.md +20 -0
  171. package/assets/docs/guide/api/node/type-aliases/fontweight.md +30 -0
  172. package/assets/docs/guide/api/node/type-aliases/gradientstoprgba.md +23 -0
  173. package/assets/docs/guide/api/node/type-aliases/heightmode.md +18 -0
  174. package/assets/docs/guide/api/node/type-aliases/hexcolorstring.md +20 -0
  175. package/assets/docs/guide/api/node/type-aliases/historyid.md +20 -0
  176. package/assets/docs/guide/api/node/type-aliases/historyupdate.md +25 -0
  177. package/assets/docs/guide/api/node/type-aliases/horizontalblockalignment.md +18 -0
  178. package/assets/docs/guide/api/node/type-aliases/horizontalcontentfillalignment.md +18 -0
  179. package/assets/docs/guide/api/node/type-aliases/horizontaltextalignment.md +18 -0
  180. package/assets/docs/guide/api/node/type-aliases/imagemimetype.md +25 -0
  181. package/assets/docs/guide/api/node/type-aliases/intpropertyname.md +26 -0
  182. package/assets/docs/guide/api/node/type-aliases/liststyle.md +20 -0
  183. package/assets/docs/guide/api/node/type-aliases/locale.md +20 -0
  184. package/assets/docs/guide/api/node/type-aliases/loglevel.md +24 -0
  185. package/assets/docs/guide/api/node/type-aliases/mimetype.md +20 -0
  186. package/assets/docs/guide/api/node/type-aliases/objecttype.md +24 -0
  187. package/assets/docs/guide/api/node/type-aliases/objecttypelonghand.md +27 -0
  188. package/assets/docs/guide/api/node/type-aliases/objecttypeshorthand.md +27 -0
  189. package/assets/docs/guide/api/node/type-aliases/optionalprefix.md +24 -0
  190. package/assets/docs/guide/api/node/type-aliases/pageguidessource.md +18 -0
  191. package/assets/docs/guide/api/node/type-aliases/palettecolor.md +24 -0
  192. package/assets/docs/guide/api/node/type-aliases/positionmode.md +20 -0
  193. package/assets/docs/guide/api/node/type-aliases/positionxmode.md +18 -0
  194. package/assets/docs/guide/api/node/type-aliases/positionymode.md +18 -0
  195. package/assets/docs/guide/api/node/type-aliases/propertytype.md +31 -0
  196. package/assets/docs/guide/api/node/type-aliases/rgba.md +23 -0
  197. package/assets/docs/guide/api/node/type-aliases/rolestring.md +23 -0
  198. package/assets/docs/guide/api/node/type-aliases/scenefontsizeunit.md +18 -0
  199. package/assets/docs/guide/api/node/type-aliases/scenelayout.md +18 -0
  200. package/assets/docs/guide/api/node/type-aliases/scenemode.md +18 -0
  201. package/assets/docs/guide/api/node/type-aliases/scope.md +50 -0
  202. package/assets/docs/guide/api/node/type-aliases/settingboolpropertyname.md +62 -0
  203. package/assets/docs/guide/api/node/type-aliases/settingcolorpropertyname.md +38 -0
  204. package/assets/docs/guide/api/node/type-aliases/settingenumpropertyname.md +29 -0
  205. package/assets/docs/guide/api/node/type-aliases/settingenumtype.md +33 -0
  206. package/assets/docs/guide/api/node/type-aliases/settingenumvalues.md +29 -0
  207. package/assets/docs/guide/api/node/type-aliases/settingfloatpropertyname.md +25 -0
  208. package/assets/docs/guide/api/node/type-aliases/settingintpropertyname.md +18 -0
  209. package/assets/docs/guide/api/node/type-aliases/settingkey.md +20 -0
  210. package/assets/docs/guide/api/node/type-aliases/settingsbool.md +18 -0
  211. package/assets/docs/guide/api/node/type-aliases/settingscolor.md +20 -0
  212. package/assets/docs/guide/api/node/type-aliases/settingscolorrgba.md +24 -0
  213. package/assets/docs/guide/api/node/type-aliases/settingsenum.md +18 -0
  214. package/assets/docs/guide/api/node/type-aliases/settingsfloat.md +18 -0
  215. package/assets/docs/guide/api/node/type-aliases/settingsint.md +18 -0
  216. package/assets/docs/guide/api/node/type-aliases/settingsstring.md +18 -0
  217. package/assets/docs/guide/api/node/type-aliases/settingstringpropertyname.md +28 -0
  218. package/assets/docs/guide/api/node/type-aliases/settingtype.md +20 -0
  219. package/assets/docs/guide/api/node/type-aliases/settingvaluetype.md +26 -0
  220. package/assets/docs/guide/api/node/type-aliases/shapetype.md +24 -0
  221. package/assets/docs/guide/api/node/type-aliases/shapetypelonghand.md +21 -0
  222. package/assets/docs/guide/api/node/type-aliases/shapetypeshorthand.md +18 -0
  223. package/assets/docs/guide/api/node/type-aliases/shapevectorpathfillrule.md +18 -0
  224. package/assets/docs/guide/api/node/type-aliases/sizemode.md +20 -0
  225. package/assets/docs/guide/api/node/type-aliases/sortingorder.md +21 -0
  226. package/assets/docs/guide/api/node/type-aliases/sourcesetpropertyname.md +18 -0
  227. package/assets/docs/guide/api/node/type-aliases/splitoptions.md +28 -0
  228. package/assets/docs/guide/api/node/type-aliases/stringpropertyname.md +43 -0
  229. package/assets/docs/guide/api/node/type-aliases/strokecap.md +18 -0
  230. package/assets/docs/guide/api/node/type-aliases/strokecornergeometry.md +18 -0
  231. package/assets/docs/guide/api/node/type-aliases/strokedashendcap.md +18 -0
  232. package/assets/docs/guide/api/node/type-aliases/strokedashstartcap.md +18 -0
  233. package/assets/docs/guide/api/node/type-aliases/strokeendcap.md +18 -0
  234. package/assets/docs/guide/api/node/type-aliases/strokeposition.md +18 -0
  235. package/assets/docs/guide/api/node/type-aliases/strokestartcap.md +18 -0
  236. package/assets/docs/guide/api/node/type-aliases/strokestyle.md +18 -0
  237. package/assets/docs/guide/api/node/type-aliases/syncuriresolver.md +31 -0
  238. package/assets/docs/guide/api/node/type-aliases/textanimationwritingstyle.md +18 -0
  239. package/assets/docs/guide/api/node/type-aliases/textcase.md +20 -0
  240. package/assets/docs/guide/api/node/type-aliases/textdecorationline.md +27 -0
  241. package/assets/docs/guide/api/node/type-aliases/textdecorationstyle.md +26 -0
  242. package/assets/docs/guide/api/node/type-aliases/textverticalalignment.md +18 -0
  243. package/assets/docs/guide/api/node/type-aliases/timelinetrackvisibility.md +18 -0
  244. package/assets/docs/guide/api/node/type-aliases/touchpinchaction.md +18 -0
  245. package/assets/docs/guide/api/node/type-aliases/touchrotateaction.md +18 -0
  246. package/assets/docs/guide/api/node/type-aliases/typefacedefinition.md +41 -0
  247. package/assets/docs/guide/api/node/type-aliases/verticalblockalignment.md +18 -0
  248. package/assets/docs/guide/api/node/type-aliases/verticalcontentfillalignment.md +18 -0
  249. package/assets/docs/guide/api/node/type-aliases/videoexportoptions.md +54 -0
  250. package/assets/docs/guide/api/node/type-aliases/videomimetype.md +20 -0
  251. package/assets/docs/guide/api/node/type-aliases/widthmode.md +18 -0
  252. package/assets/docs/guide/api/node/type-aliases/xywh.md +23 -0
  253. package/assets/docs/guide/api/node/type-aliases/zoomautofitaxis.md +20 -0
  254. package/assets/docs/guide/api/node/type-aliases/zoomoptions.md +27 -0
  255. package/assets/docs/guide/api/node/variables/animation_types.md +21 -0
  256. package/assets/docs/guide/api/node/variables/animationbaselinedirectionvalues.md +18 -0
  257. package/assets/docs/guide/api/node/variables/animationblockswipetextdirectionvalues.md +18 -0
  258. package/assets/docs/guide/api/node/variables/animationeasingvalues.md +18 -0
  259. package/assets/docs/guide/api/node/variables/animationgrowdirectionvalues.md +18 -0
  260. package/assets/docs/guide/api/node/variables/animationjumploopdirectionvalues.md +18 -0
  261. package/assets/docs/guide/api/node/variables/animationkenburnsdirectionvalues.md +18 -0
  262. package/assets/docs/guide/api/node/variables/animationmergetextdirectionvalues.md +18 -0
  263. package/assets/docs/guide/api/node/variables/animationspindirectionvalues.md +18 -0
  264. package/assets/docs/guide/api/node/variables/animationspinloopdirectionvalues.md +18 -0
  265. package/assets/docs/guide/api/node/variables/animationtypewritertextwritingstylevalues.md +18 -0
  266. package/assets/docs/guide/api/node/variables/animationwipedirectionvalues.md +18 -0
  267. package/assets/docs/guide/api/node/variables/blendmodevalues.md +18 -0
  268. package/assets/docs/guide/api/node/variables/blur_types.md +21 -0
  269. package/assets/docs/guide/api/node/variables/cameraclampingovershootmodevalues.md +18 -0
  270. package/assets/docs/guide/api/node/variables/captionhorizontalalignmentvalues.md +18 -0
  271. package/assets/docs/guide/api/node/variables/captionverticalalignmentvalues.md +18 -0
  272. package/assets/docs/guide/api/node/variables/colorpickercolormodevalues.md +18 -0
  273. package/assets/docs/guide/api/node/variables/contentfillmodevalues.md +18 -0
  274. package/assets/docs/guide/api/node/variables/controlgizmomovehandlevisibilityvalues.md +18 -0
  275. package/assets/docs/guide/api/node/variables/controlgizmoresizehandlesvisibilityvalues.md +18 -0
  276. package/assets/docs/guide/api/node/variables/controlgizmorotatehandlesvisibilityvalues.md +18 -0
  277. package/assets/docs/guide/api/node/variables/controlgizmoscalehandlesvisibilityvalues.md +18 -0
  278. package/assets/docs/guide/api/node/variables/cutouttypevalues.md +18 -0
  279. package/assets/docs/guide/api/node/variables/design_block_types.md +21 -0
  280. package/assets/docs/guide/api/node/variables/doubleclickselectionmodevalues.md +18 -0
  281. package/assets/docs/guide/api/node/variables/effect_types.md +21 -0
  282. package/assets/docs/guide/api/node/variables/fill_types.md +21 -0
  283. package/assets/docs/guide/api/node/variables/fillpixelstreamorientationvalues.md +18 -0
  284. package/assets/docs/guide/api/node/variables/heightmodevalues.md +18 -0
  285. package/assets/docs/guide/api/node/variables/horizontalcontentfillalignmentvalues.md +18 -0
  286. package/assets/docs/guide/api/node/variables/loglevel.md +37 -0
  287. package/assets/docs/guide/api/node/variables/mimetype.md +41 -0
  288. package/assets/docs/guide/api/node/variables/pageguidessourcevalues.md +18 -0
  289. package/assets/docs/guide/api/node/variables/positionxmodevalues.md +18 -0
  290. package/assets/docs/guide/api/node/variables/positionymodevalues.md +18 -0
  291. package/assets/docs/guide/api/node/variables/scenedesignunitvalues.md +18 -0
  292. package/assets/docs/guide/api/node/variables/scenefontsizeunitvalues.md +18 -0
  293. package/assets/docs/guide/api/node/variables/scenelayoutvalues.md +18 -0
  294. package/assets/docs/guide/api/node/variables/scenemodevalues.md +18 -0
  295. package/assets/docs/guide/api/node/variables/shape_types.md +21 -0
  296. package/assets/docs/guide/api/node/variables/shapevectorpathfillrulevalues.md +18 -0
  297. package/assets/docs/guide/api/node/variables/strokecapvalues.md +18 -0
  298. package/assets/docs/guide/api/node/variables/strokecornergeometryvalues.md +18 -0
  299. package/assets/docs/guide/api/node/variables/strokedashendcapvalues.md +18 -0
  300. package/assets/docs/guide/api/node/variables/strokedashstartcapvalues.md +18 -0
  301. package/assets/docs/guide/api/node/variables/strokeendcapvalues.md +18 -0
  302. package/assets/docs/guide/api/node/variables/strokepositionvalues.md +18 -0
  303. package/assets/docs/guide/api/node/variables/strokestartcapvalues.md +18 -0
  304. package/assets/docs/guide/api/node/variables/strokestylevalues.md +18 -0
  305. package/assets/docs/guide/api/node/variables/textanimationwritingstylevalues.md +18 -0
  306. package/assets/docs/guide/api/node/variables/texthorizontalalignmentvalues.md +18 -0
  307. package/assets/docs/guide/api/node/variables/textverticalalignmentvalues.md +18 -0
  308. package/assets/docs/guide/api/node/variables/timelinetrackvisibilityvalues.md +18 -0
  309. package/assets/docs/guide/api/node/variables/touchpinchactionvalues.md +18 -0
  310. package/assets/docs/guide/api/node/variables/touchrotateactionvalues.md +18 -0
  311. package/assets/docs/guide/api/node/variables/verticalcontentfillalignmentvalues.md +18 -0
  312. package/assets/docs/guide/api/node/variables/widthmodevalues.md +18 -0
  313. package/assets/docs/guide/api/types.md +5 -9
  314. package/assets/docs/guide/api-reference/overview.md +7 -7
  315. package/assets/docs/guide/automation/auto-resize.md +263 -300
  316. package/assets/docs/guide/automation/data-merge.md +246 -275
  317. package/assets/docs/guide/automation/design-generation.md +102 -31
  318. package/assets/docs/guide/automation/multi-image-generation.md +758 -0
  319. package/assets/docs/guide/automation/overview.md +21 -4
  320. package/assets/docs/guide/automation.md +10 -5
  321. package/assets/docs/guide/capabilities.md +6 -4
  322. package/assets/docs/guide/colors/adjust.md +247 -249
  323. package/assets/docs/guide/colors/apply.md +127 -138
  324. package/assets/docs/guide/colors/basics.md +126 -150
  325. package/assets/docs/guide/colors/conversion.md +171 -177
  326. package/assets/docs/guide/colors/create-color-palette.md +244 -245
  327. package/assets/docs/guide/colors/extract-colors.md +144 -0
  328. package/assets/docs/guide/colors/for-print/cmyk.md +292 -352
  329. package/assets/docs/guide/colors/for-print/spot.md +521 -578
  330. package/assets/docs/guide/colors/for-print.md +9 -4
  331. package/assets/docs/guide/colors/for-screen/p3.md +12 -10
  332. package/assets/docs/guide/colors/for-screen/srgb.md +107 -133
  333. package/assets/docs/guide/colors/for-screen.md +9 -4
  334. package/assets/docs/guide/colors/overview.md +6 -4
  335. package/assets/docs/guide/colors/replace.md +381 -419
  336. package/assets/docs/guide/colors.md +9 -4
  337. package/assets/docs/guide/compatibility.md +7 -5
  338. package/assets/docs/guide/concepts/architecture.md +17 -15
  339. package/assets/docs/guide/concepts/assets.md +152 -140
  340. package/assets/docs/guide/concepts/blocks.md +227 -323
  341. package/assets/docs/guide/concepts/buffers.md +147 -276
  342. package/assets/docs/guide/concepts/design-units.md +95 -145
  343. package/assets/docs/guide/concepts/editing-workflow.md +69 -183
  344. package/assets/docs/guide/concepts/events.md +80 -122
  345. package/assets/docs/guide/concepts/headless-mode.md +237 -0
  346. package/assets/docs/guide/concepts/pages.md +137 -127
  347. package/assets/docs/guide/concepts/resources.md +156 -217
  348. package/assets/docs/guide/concepts/scenes.md +191 -210
  349. package/assets/docs/guide/concepts/templating.md +118 -74
  350. package/assets/docs/guide/concepts/terminology.md +49 -47
  351. package/assets/docs/guide/concepts/undo-and-history.md +229 -303
  352. package/assets/docs/guide/concepts.md +9 -7
  353. package/assets/docs/guide/configuration.md +252 -380
  354. package/assets/docs/guide/conversion/overview.md +33 -4
  355. package/assets/docs/guide/conversion/to-base64.md +127 -167
  356. package/assets/docs/guide/conversion/to-pdf.md +24 -474
  357. package/assets/docs/guide/conversion/to-png.md +168 -211
  358. package/assets/docs/guide/conversion.md +9 -4
  359. package/assets/docs/guide/create-audio/audio/add-music.md +301 -327
  360. package/assets/docs/guide/create-audio/audio/add-sound-effects.md +475 -359
  361. package/assets/docs/guide/create-audio/audio/loop.md +232 -272
  362. package/assets/docs/guide/create-composition/add-background.md +237 -239
  363. package/assets/docs/guide/create-composition/blend-modes.md +118 -209
  364. package/assets/docs/guide/create-composition/collage.md +538 -320
  365. package/assets/docs/guide/create-composition/group-and-ungroup.md +216 -261
  366. package/assets/docs/guide/create-composition/layer-management.md +219 -257
  367. package/assets/docs/guide/create-composition/layout.md +513 -315
  368. package/assets/docs/guide/create-composition/lock-design.md +90 -109
  369. package/assets/docs/guide/create-composition/multi-page.md +133 -113
  370. package/assets/docs/guide/create-composition/overview.md +16 -4
  371. package/assets/docs/guide/create-composition/programmatic.md +288 -344
  372. package/assets/docs/guide/create-composition.md +10 -5
  373. package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +443 -569
  374. package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +567 -470
  375. package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +179 -516
  376. package/assets/docs/guide/create-templates/add-dynamic-content.md +226 -224
  377. package/assets/docs/guide/create-templates/add-to-template-library.md +183 -193
  378. package/assets/docs/guide/create-templates/edit-or-remove.md +297 -303
  379. package/assets/docs/guide/create-templates/from-scratch.md +207 -268
  380. package/assets/docs/guide/create-templates/import/from-scene-file.md +158 -236
  381. package/assets/docs/guide/create-templates/import.md +145 -161
  382. package/assets/docs/guide/create-templates/lock.md +42 -295
  383. package/assets/docs/guide/create-templates/overview.md +33 -4
  384. package/assets/docs/guide/create-templates.md +9 -5
  385. package/assets/docs/guide/create-video/audio/adjust-speed.md +157 -207
  386. package/assets/docs/guide/create-video/audio/adjust-volume.md +116 -227
  387. package/assets/docs/guide/create-video/control.md +352 -193
  388. package/assets/docs/guide/create-video/limitations.md +175 -280
  389. package/assets/docs/guide/create-video.md +11 -10
  390. package/assets/docs/guide/edit-image/add-watermark.md +283 -330
  391. package/assets/docs/guide/edit-image/overview.md +29 -4
  392. package/assets/docs/guide/edit-image/remove-bg.md +283 -337
  393. package/assets/docs/guide/edit-image/replace-colors.md +424 -502
  394. package/assets/docs/guide/edit-image/transform/crop.md +463 -402
  395. package/assets/docs/guide/edit-image/transform/flip.md +353 -0
  396. package/assets/docs/guide/edit-image/transform/move.md +143 -100
  397. package/assets/docs/guide/edit-image/transform/resize.md +118 -88
  398. package/assets/docs/guide/edit-image/transform/rotate.md +132 -165
  399. package/assets/docs/guide/edit-image/transform/scale.md +230 -228
  400. package/assets/docs/guide/edit-image/transform.md +10 -5
  401. package/assets/docs/guide/edit-image.md +11 -7
  402. package/assets/docs/guide/edit-video/add-captions.md +344 -421
  403. package/assets/docs/guide/edit-video/add-watermark.md +312 -258
  404. package/assets/docs/guide/edit-video/join-and-arrange.md +237 -371
  405. package/assets/docs/guide/edit-video/redaction.md +419 -385
  406. package/assets/docs/guide/edit-video/split.md +243 -493
  407. package/assets/docs/guide/edit-video/transform/crop.md +21 -352
  408. package/assets/docs/guide/edit-video/transform/flip.md +102 -76
  409. package/assets/docs/guide/edit-video/transform/move.md +258 -310
  410. package/assets/docs/guide/edit-video/transform/resize.md +264 -428
  411. package/assets/docs/guide/edit-video/transform/rotate.md +265 -228
  412. package/assets/docs/guide/edit-video/transform/scale.md +320 -417
  413. package/assets/docs/guide/edit-video/transform.md +10 -6
  414. package/assets/docs/guide/edit-video/trim.md +448 -494
  415. package/assets/docs/guide/engine-interface.md +51 -62
  416. package/assets/docs/guide/export-save-publish/create-thumbnail.md +148 -184
  417. package/assets/docs/guide/export-save-publish/export/compress.md +161 -559
  418. package/assets/docs/guide/export-save-publish/export/overview.md +224 -373
  419. package/assets/docs/guide/export-save-publish/export/partial-export.md +386 -577
  420. package/assets/docs/guide/export-save-publish/export/size-limits.md +215 -310
  421. package/assets/docs/guide/export-save-publish/export/to-jpeg.md +132 -213
  422. package/assets/docs/guide/export-save-publish/export/to-pdf.md +139 -267
  423. package/assets/docs/guide/export-save-publish/export/to-png.md +121 -165
  424. package/assets/docs/guide/export-save-publish/export/to-raw-data.md +187 -234
  425. package/assets/docs/guide/export-save-publish/export/to-webp.md +160 -190
  426. package/assets/docs/guide/export-save-publish/export/with-color-mask.md +359 -203
  427. package/assets/docs/guide/export-save-publish/export.md +14 -11
  428. package/assets/docs/guide/export-save-publish/for-printing.md +141 -237
  429. package/assets/docs/guide/export-save-publish/for-social-media.md +124 -261
  430. package/assets/docs/guide/export-save-publish/pre-export-validation.md +436 -522
  431. package/assets/docs/guide/export-save-publish/save.md +167 -226
  432. package/assets/docs/guide/export-save-publish/store-custom-metadata.md +97 -162
  433. package/assets/docs/guide/file-format-support.md +9 -9
  434. package/assets/docs/guide/fills/color.md +370 -347
  435. package/assets/docs/guide/fills/image.md +167 -196
  436. package/assets/docs/guide/fills/overview.md +6 -4
  437. package/assets/docs/guide/fills/video.md +286 -438
  438. package/assets/docs/guide/fills.md +12 -8
  439. package/assets/docs/guide/filters-and-effects/apply.md +598 -664
  440. package/assets/docs/guide/filters-and-effects/blur.md +261 -159
  441. package/assets/docs/guide/filters-and-effects/chroma-key-green-screen.md +194 -293
  442. package/assets/docs/guide/filters-and-effects/create-custom-filters.md +548 -466
  443. package/assets/docs/guide/filters-and-effects/create-custom-lut-filter.md +176 -244
  444. package/assets/docs/guide/filters-and-effects/distortion.md +317 -384
  445. package/assets/docs/guide/filters-and-effects/duotone.md +221 -217
  446. package/assets/docs/guide/filters-and-effects/gradients.md +670 -813
  447. package/assets/docs/guide/filters-and-effects/overview.md +7 -7
  448. package/assets/docs/guide/filters-and-effects/support.md +97 -132
  449. package/assets/docs/guide/filters-and-effects.md +11 -6
  450. package/assets/docs/guide/get-started/agent-skills.md +20 -18
  451. package/assets/docs/guide/get-started/build-with-ai.md +7 -4
  452. package/assets/docs/guide/get-started/bun.md +219 -0
  453. package/assets/docs/guide/get-started/deno.md +161 -0
  454. package/assets/docs/guide/get-started/mcp-server.md +6 -4
  455. package/assets/docs/guide/get-started/overview.md +11 -6
  456. package/assets/docs/guide/get-started/vanilla-aws-lambda.md +506 -0
  457. package/assets/docs/guide/get-started/vanilla-clone-github-project.md +124 -0
  458. package/assets/docs/guide/get-started/vanilla.md +235 -0
  459. package/assets/docs/guide/guides/export-save-publish/export/audio.md +80 -66
  460. package/assets/docs/guide/guides.md +10 -9
  461. package/assets/docs/guide/import-media/asset-panel/refresh-assets.md +259 -288
  462. package/assets/docs/guide/import-media/concepts.md +20 -38
  463. package/assets/docs/guide/import-media/content-json-schema.md +145 -125
  464. package/assets/docs/guide/import-media/default-assets.md +113 -161
  465. package/assets/docs/guide/import-media/edit-or-remove-assets.md +391 -395
  466. package/assets/docs/guide/import-media/file-format-support.md +78 -61
  467. package/assets/docs/guide/import-media/from-remote-source/asset-versioning.md +273 -244
  468. package/assets/docs/guide/import-media/from-remote-source/remote-asset.md +152 -222
  469. package/assets/docs/guide/import-media/from-remote-source.md +9 -11
  470. package/assets/docs/guide/import-media/overview.md +5 -5
  471. package/assets/docs/guide/import-media/retrieve-mimetype.md +216 -108
  472. package/assets/docs/guide/import-media/size-limits.md +6 -4
  473. package/assets/docs/guide/import-media/source-sets.md +190 -251
  474. package/assets/docs/guide/import-media.md +10 -8
  475. package/assets/docs/guide/insert-media/audio.md +202 -195
  476. package/assets/docs/guide/insert-media/images.md +190 -188
  477. package/assets/docs/guide/insert-media/position-and-align.md +284 -551
  478. package/assets/docs/guide/insert-media/shapes-or-stickers.md +402 -418
  479. package/assets/docs/guide/insert-media/videos.md +236 -203
  480. package/assets/docs/guide/insert-media.md +10 -5
  481. package/assets/docs/guide/key-capabilities.md +36 -4
  482. package/assets/docs/guide/key-concepts.md +6 -4
  483. package/assets/docs/guide/licensing.md +6 -4
  484. package/assets/docs/guide/llms-txt.md +11 -7
  485. package/assets/docs/guide/open-the-editor/blank-canvas.md +102 -63
  486. package/assets/docs/guide/open-the-editor/from-image.md +157 -127
  487. package/assets/docs/guide/open-the-editor/from-template.md +131 -92
  488. package/assets/docs/guide/open-the-editor/from-video.md +204 -212
  489. package/assets/docs/guide/open-the-editor/import-design/from-archive.md +310 -360
  490. package/assets/docs/guide/open-the-editor/import-design/from-indesign.md +716 -513
  491. package/assets/docs/guide/open-the-editor/import-design/from-photoshop.md +667 -695
  492. package/assets/docs/guide/open-the-editor/import-design.md +228 -266
  493. package/assets/docs/guide/open-the-editor/load-scene.md +72 -68
  494. package/assets/docs/guide/open-the-editor/overview.md +6 -4
  495. package/assets/docs/guide/open-the-editor/uri-resolver.md +160 -251
  496. package/assets/docs/guide/open-the-editor.md +11 -9
  497. package/assets/docs/guide/outlines/overview.md +12 -4
  498. package/assets/docs/guide/outlines/shadows-and-glows.md +105 -410
  499. package/assets/docs/guide/outlines/strokes.md +218 -166
  500. package/assets/docs/guide/outlines.md +9 -4
  501. package/assets/docs/guide/overview.md +14 -6
  502. package/assets/docs/guide/performance.md +220 -113
  503. package/assets/docs/guide/plugins/print-ready-pdf.md +273 -368
  504. package/assets/docs/guide/plugins.md +10 -16
  505. package/assets/docs/guide/rules/asset-handling.md +7 -18
  506. package/assets/docs/guide/rules/common-pitfalls.md +25 -42
  507. package/assets/docs/guide/rules/content-fill-mode.md +4 -4
  508. package/assets/docs/guide/rules/enforce-brand-guidelines.md +398 -567
  509. package/assets/docs/guide/rules/lock-content.md +188 -231
  510. package/assets/docs/guide/rules/moderate-content.md +580 -571
  511. package/assets/docs/guide/rules/overview.md +345 -380
  512. package/assets/docs/guide/rules/silent-init-errors.md +4 -1
  513. package/assets/docs/guide/rules/verify-properties-before-use.md +2 -11
  514. package/assets/docs/guide/rules.md +10 -5
  515. package/assets/docs/guide/security.md +7 -5
  516. package/assets/docs/guide/serve-assets.md +57 -284
  517. package/assets/docs/guide/settings.md +96 -74
  518. package/assets/docs/guide/shapes.md +10 -5
  519. package/assets/docs/guide/stickers-and-shapes/combine.md +397 -583
  520. package/assets/docs/guide/stickers-and-shapes/create-cutout.md +181 -268
  521. package/assets/docs/guide/stickers-and-shapes/create-edit/create-shapes.md +418 -431
  522. package/assets/docs/guide/stickers-and-shapes/create-edit/create-stickers.md +147 -226
  523. package/assets/docs/guide/stickers-and-shapes/create-edit/edit-shapes.md +138 -123
  524. package/assets/docs/guide/stickers-and-shapes/insert-qr-code.md +151 -149
  525. package/assets/docs/guide/stickers.md +9 -4
  526. package/assets/docs/guide/text/add.md +470 -482
  527. package/assets/docs/guide/text/adjust-spacing.md +179 -214
  528. package/assets/docs/guide/text/auto-size.md +210 -271
  529. package/assets/docs/guide/text/edit.md +294 -309
  530. package/assets/docs/guide/text/effects.md +154 -190
  531. package/assets/docs/guide/text/emojis.md +199 -232
  532. package/assets/docs/guide/text/language-support.md +369 -382
  533. package/assets/docs/guide/text/overview.md +41 -4
  534. package/assets/docs/guide/text/styling.md +239 -273
  535. package/assets/docs/guide/text/text-designs.md +405 -544
  536. package/assets/docs/guide/text.md +10 -9
  537. package/assets/docs/guide/to-v1-19.md +12 -10
  538. package/assets/docs/guide/upgrade.md +8 -9
  539. package/assets/docs/guide/use-templates/apply-template.md +174 -163
  540. package/assets/docs/guide/use-templates/generate.md +171 -152
  541. package/assets/docs/guide/use-templates/overview.md +32 -4
  542. package/assets/docs/guide/use-templates/programmatic.md +266 -301
  543. package/assets/docs/guide/use-templates/replace-content.md +181 -171
  544. package/assets/docs/guide/what-is-cesdk.md +71 -282
  545. package/assets/docs/handbook/SKILL.md +24 -0
  546. package/dist/assets/inline.generated.d.ts.map +1 -1
  547. package/dist/assets/inline.generated.js +544 -406
  548. package/dist/assets/inline.generated.js.map +1 -1
  549. package/dist/assets/load-browser.d.ts +1 -1
  550. package/dist/assets/load-browser.js +1 -1
  551. package/dist/assets/load-browser.js.map +1 -1
  552. package/dist/assets/load-node.d.ts +1 -1
  553. package/dist/assets/load-node.js +1 -1
  554. package/dist/assets/load-node.js.map +1 -1
  555. package/dist/cli/http.d.ts.map +1 -1
  556. package/dist/cli/http.js +4 -28
  557. package/dist/cli/http.js.map +1 -1
  558. package/dist/cli/redirect-console.d.ts +1 -1
  559. package/dist/cli/redirect-console.d.ts.map +1 -1
  560. package/dist/cli/redirect-console.js +12 -3
  561. package/dist/cli/redirect-console.js.map +1 -1
  562. package/dist/cli/resolve-license.d.ts.map +1 -1
  563. package/dist/cli/resolve-license.js +8 -6
  564. package/dist/cli/resolve-license.js.map +1 -1
  565. package/dist/cli/stdio.d.ts +9 -0
  566. package/dist/cli/stdio.d.ts.map +1 -1
  567. package/dist/cli/stdio.js +48 -4
  568. package/dist/cli/stdio.js.map +1 -1
  569. package/dist/cli.js +10 -1
  570. package/dist/cli.js.map +1 -1
  571. package/dist/config.d.ts +11 -2
  572. package/dist/config.d.ts.map +1 -1
  573. package/dist/config.js +20 -1
  574. package/dist/config.js.map +1 -1
  575. package/dist/diagnostics/bundle.d.ts +10 -0
  576. package/dist/diagnostics/bundle.d.ts.map +1 -0
  577. package/dist/diagnostics/bundle.js +148 -0
  578. package/dist/diagnostics/bundle.js.map +1 -0
  579. package/dist/diagnostics/compose.d.ts +3 -0
  580. package/dist/diagnostics/compose.d.ts.map +1 -0
  581. package/dist/diagnostics/compose.js +15 -0
  582. package/dist/diagnostics/compose.js.map +1 -0
  583. package/dist/diagnostics/events.d.ts +34 -0
  584. package/dist/diagnostics/events.d.ts.map +1 -0
  585. package/dist/diagnostics/events.js +3 -0
  586. package/dist/diagnostics/events.js.map +1 -0
  587. package/dist/diagnostics/file-sink.d.ts +38 -0
  588. package/dist/diagnostics/file-sink.d.ts.map +1 -0
  589. package/dist/diagnostics/file-sink.js +157 -0
  590. package/dist/diagnostics/file-sink.js.map +1 -0
  591. package/dist/diagnostics/redact.d.ts +7 -0
  592. package/dist/diagnostics/redact.d.ts.map +1 -0
  593. package/dist/diagnostics/redact.js +43 -0
  594. package/dist/diagnostics/redact.js.map +1 -0
  595. package/dist/diagnostics/tool-call-adapter.d.ts +4 -0
  596. package/dist/diagnostics/tool-call-adapter.d.ts.map +1 -0
  597. package/dist/diagnostics/tool-call-adapter.js +21 -0
  598. package/dist/diagnostics/tool-call-adapter.js.map +1 -0
  599. package/dist/engine/cesdk-adapter.d.ts +5 -1
  600. package/dist/engine/cesdk-adapter.d.ts.map +1 -1
  601. package/dist/engine/cesdk-adapter.js +9 -2
  602. package/dist/engine/cesdk-adapter.js.map +1 -1
  603. package/dist/engine/index.d.ts +1 -0
  604. package/dist/engine/index.d.ts.map +1 -1
  605. package/dist/engine/index.js +4 -0
  606. package/dist/engine/index.js.map +1 -1
  607. package/dist/engine/scene-resource-schemes.d.ts +2 -0
  608. package/dist/engine/scene-resource-schemes.d.ts.map +1 -0
  609. package/dist/engine/scene-resource-schemes.js +20 -0
  610. package/dist/engine/scene-resource-schemes.js.map +1 -0
  611. package/dist/http/server.d.ts +0 -6
  612. package/dist/http/server.d.ts.map +1 -1
  613. package/dist/http/server.js +1 -2
  614. package/dist/http/server.js.map +1 -1
  615. package/dist/server.d.ts +0 -4
  616. package/dist/server.d.ts.map +1 -1
  617. package/dist/server.js +4 -60
  618. package/dist/server.js.map +1 -1
  619. package/dist/test/scripts/changelog-add.d.ts +8 -0
  620. package/dist/test/scripts/changelog-add.d.ts.map +1 -0
  621. package/dist/test/scripts/changelog-add.js +50 -0
  622. package/dist/test/scripts/changelog-add.js.map +1 -0
  623. package/dist/test/scripts/changelog-collate.d.ts +38 -0
  624. package/dist/test/scripts/changelog-collate.d.ts.map +1 -0
  625. package/dist/test/scripts/changelog-collate.js +171 -0
  626. package/dist/test/scripts/changelog-collate.js.map +1 -0
  627. package/dist/test/test/changelog.test.d.ts +2 -0
  628. package/dist/test/test/changelog.test.d.ts.map +1 -0
  629. package/dist/test/test/changelog.test.js +293 -0
  630. package/dist/test/test/changelog.test.js.map +1 -0
  631. package/dist/test/test/cli/dispatcher.test.js +10 -3
  632. package/dist/test/test/cli/dispatcher.test.js.map +1 -1
  633. package/dist/test/test/cli/redirect-console.test.js +31 -0
  634. package/dist/test/test/cli/redirect-console.test.js.map +1 -1
  635. package/dist/test/test/cli/resolve-license.test.js +10 -1
  636. package/dist/test/test/cli/resolve-license.test.js.map +1 -1
  637. package/dist/test/test/cli/stdio-diagnostics.test.d.ts +2 -0
  638. package/dist/test/test/cli/stdio-diagnostics.test.d.ts.map +1 -0
  639. package/dist/test/test/cli/stdio-diagnostics.test.js +31 -0
  640. package/dist/test/test/cli/stdio-diagnostics.test.js.map +1 -0
  641. package/dist/test/test/config.test.js +17 -13
  642. package/dist/test/test/config.test.js.map +1 -1
  643. package/dist/test/test/diagnostics/bundle.test.d.ts +2 -0
  644. package/dist/test/test/diagnostics/bundle.test.d.ts.map +1 -0
  645. package/dist/test/test/diagnostics/bundle.test.js +53 -0
  646. package/dist/test/test/diagnostics/bundle.test.js.map +1 -0
  647. package/dist/test/test/diagnostics/compose.test.d.ts +2 -0
  648. package/dist/test/test/diagnostics/compose.test.d.ts.map +1 -0
  649. package/dist/test/test/diagnostics/compose.test.js +31 -0
  650. package/dist/test/test/diagnostics/compose.test.js.map +1 -0
  651. package/dist/test/test/diagnostics/file-sink.test.d.ts +2 -0
  652. package/dist/test/test/diagnostics/file-sink.test.d.ts.map +1 -0
  653. package/dist/test/test/diagnostics/file-sink.test.js +113 -0
  654. package/dist/test/test/diagnostics/file-sink.test.js.map +1 -0
  655. package/dist/test/test/diagnostics/redact.test.d.ts +2 -0
  656. package/dist/test/test/diagnostics/redact.test.d.ts.map +1 -0
  657. package/dist/test/test/diagnostics/redact.test.js +59 -0
  658. package/dist/test/test/diagnostics/redact.test.js.map +1 -0
  659. package/dist/test/test/diagnostics/tool-call-adapter.test.d.ts +2 -0
  660. package/dist/test/test/diagnostics/tool-call-adapter.test.d.ts.map +1 -0
  661. package/dist/test/test/diagnostics/tool-call-adapter.test.js +34 -0
  662. package/dist/test/test/diagnostics/tool-call-adapter.test.js.map +1 -0
  663. package/dist/test/test/engine/cesdk-adapter.test.d.ts +2 -0
  664. package/dist/test/test/engine/cesdk-adapter.test.d.ts.map +1 -0
  665. package/dist/test/test/engine/cesdk-adapter.test.js +32 -0
  666. package/dist/test/test/engine/cesdk-adapter.test.js.map +1 -0
  667. package/dist/test/test/handbook-contract.test.js +6 -2
  668. package/dist/test/test/handbook-contract.test.js.map +1 -1
  669. package/dist/test/test/http/server.test.js +0 -36
  670. package/dist/test/test/http/server.test.js.map +1 -1
  671. package/dist/test/test/http/workspace-auth.test.js +0 -1
  672. package/dist/test/test/http/workspace-auth.test.js.map +1 -1
  673. package/dist/test/test/server.test.js +0 -40
  674. package/dist/test/test/server.test.js.map +1 -1
  675. package/dist/test/test/tools/edit-harness.d.ts +14 -0
  676. package/dist/test/test/tools/edit-harness.d.ts.map +1 -0
  677. package/dist/test/test/tools/edit-harness.js +30 -0
  678. package/dist/test/test/tools/edit-harness.js.map +1 -0
  679. package/dist/test/test/tools/edit.telemetry.test.d.ts +2 -0
  680. package/dist/test/test/tools/edit.telemetry.test.d.ts.map +1 -0
  681. package/dist/test/test/tools/edit.telemetry.test.js +46 -0
  682. package/dist/test/test/tools/edit.telemetry.test.js.map +1 -0
  683. package/dist/test/test/tools/export-harness.d.ts +13 -0
  684. package/dist/test/test/tools/export-harness.d.ts.map +1 -0
  685. package/dist/test/test/tools/export-harness.js +27 -0
  686. package/dist/test/test/tools/export-harness.js.map +1 -0
  687. package/dist/test/test/tools/export.telemetry.test.d.ts +2 -0
  688. package/dist/test/test/tools/export.telemetry.test.d.ts.map +1 -0
  689. package/dist/test/test/tools/export.telemetry.test.js +65 -0
  690. package/dist/test/test/tools/export.telemetry.test.js.map +1 -0
  691. package/dist/test/test/tools/import.test.d.ts +2 -0
  692. package/dist/test/test/tools/import.test.d.ts.map +1 -0
  693. package/dist/test/test/tools/import.test.js +122 -0
  694. package/dist/test/test/tools/import.test.js.map +1 -0
  695. package/dist/test/test/tools/index.test.js +78 -16
  696. package/dist/test/test/tools/index.test.js.map +1 -1
  697. package/dist/test/test/tools/load.integration.test.d.ts +2 -0
  698. package/dist/test/test/tools/load.integration.test.d.ts.map +1 -0
  699. package/dist/test/test/tools/load.integration.test.js +165 -0
  700. package/dist/test/test/tools/load.integration.test.js.map +1 -0
  701. package/dist/test/test/tools/load.test.d.ts +2 -0
  702. package/dist/test/test/tools/load.test.d.ts.map +1 -0
  703. package/dist/test/test/tools/load.test.js +387 -0
  704. package/dist/test/test/tools/load.test.js.map +1 -0
  705. package/dist/test/test/tools/preview-harness.d.ts +9 -0
  706. package/dist/test/test/tools/preview-harness.d.ts.map +1 -0
  707. package/dist/test/test/tools/preview-harness.js +23 -0
  708. package/dist/test/test/tools/preview-harness.js.map +1 -0
  709. package/dist/test/test/tools/preview.telemetry.test.d.ts +2 -0
  710. package/dist/test/test/tools/preview.telemetry.test.d.ts.map +1 -0
  711. package/dist/test/test/tools/preview.telemetry.test.js +36 -0
  712. package/dist/test/test/tools/preview.telemetry.test.js.map +1 -0
  713. package/dist/test/test/tools/schema-best-practices.d.ts +13 -0
  714. package/dist/test/test/tools/schema-best-practices.d.ts.map +1 -0
  715. package/dist/test/test/tools/schema-best-practices.js +169 -0
  716. package/dist/test/test/tools/schema-best-practices.js.map +1 -0
  717. package/dist/test/test/tools/schema-best-practices.test.d.ts +3 -0
  718. package/dist/test/test/tools/schema-best-practices.test.d.ts.map +1 -0
  719. package/dist/test/test/tools/schema-best-practices.test.js +194 -0
  720. package/dist/test/test/tools/schema-best-practices.test.js.map +1 -0
  721. package/dist/test/test/tools/spans.test.d.ts +2 -0
  722. package/dist/test/test/tools/spans.test.d.ts.map +1 -0
  723. package/dist/test/test/tools/spans.test.js +84 -0
  724. package/dist/test/test/tools/spans.test.js.map +1 -0
  725. package/dist/test/test/viewer/cesdk-cdn.test.d.ts +2 -0
  726. package/dist/test/test/viewer/cesdk-cdn.test.d.ts.map +1 -0
  727. package/dist/test/test/viewer/cesdk-cdn.test.js +19 -0
  728. package/dist/test/test/viewer/cesdk-cdn.test.js.map +1 -0
  729. package/dist/test/test/viewer/config-route.test.d.ts +2 -0
  730. package/dist/test/test/viewer/config-route.test.d.ts.map +1 -0
  731. package/dist/test/test/viewer/config-route.test.js +28 -0
  732. package/dist/test/test/viewer/config-route.test.js.map +1 -0
  733. package/dist/test/test/viewer/spa-version.test.d.ts +2 -0
  734. package/dist/test/test/viewer/spa-version.test.d.ts.map +1 -0
  735. package/dist/test/test/viewer/spa-version.test.js +14 -0
  736. package/dist/test/test/viewer/spa-version.test.js.map +1 -0
  737. package/dist/test/test/workspace/content-hash.test.d.ts +2 -0
  738. package/dist/test/test/workspace/content-hash.test.d.ts.map +1 -0
  739. package/dist/test/test/workspace/content-hash.test.js +17 -0
  740. package/dist/test/test/workspace/content-hash.test.js.map +1 -0
  741. package/dist/test/tsconfig.test.tsbuildinfo +1 -1
  742. package/dist/test/vitest.config.js +1 -1
  743. package/dist/test/vitest.config.js.map +1 -1
  744. package/dist/tools/asset-generate.d.ts.map +1 -1
  745. package/dist/tools/asset-generate.js +1 -8
  746. package/dist/tools/asset-generate.js.map +1 -1
  747. package/dist/tools/edit.d.ts +3 -0
  748. package/dist/tools/edit.d.ts.map +1 -1
  749. package/dist/tools/edit.js +145 -96
  750. package/dist/tools/edit.js.map +1 -1
  751. package/dist/tools/export.d.ts +3 -0
  752. package/dist/tools/export.d.ts.map +1 -1
  753. package/dist/tools/export.js +146 -108
  754. package/dist/tools/export.js.map +1 -1
  755. package/dist/tools/import.d.ts +12 -0
  756. package/dist/tools/import.d.ts.map +1 -0
  757. package/dist/tools/import.js +144 -0
  758. package/dist/tools/import.js.map +1 -0
  759. package/dist/tools/index.d.ts +3 -0
  760. package/dist/tools/index.d.ts.map +1 -1
  761. package/dist/tools/index.js +44 -4
  762. package/dist/tools/index.js.map +1 -1
  763. package/dist/tools/load.d.ts +26 -0
  764. package/dist/tools/load.d.ts.map +1 -0
  765. package/dist/tools/load.js +400 -0
  766. package/dist/tools/load.js.map +1 -0
  767. package/dist/tools/preview.d.ts +3 -0
  768. package/dist/tools/preview.d.ts.map +1 -1
  769. package/dist/tools/preview.js +79 -44
  770. package/dist/tools/preview.js.map +1 -1
  771. package/dist/tools/result.d.ts +1 -1
  772. package/dist/tools/result.js +2 -2
  773. package/dist/tools/result.js.map +1 -1
  774. package/dist/tools/spans.d.ts +45 -0
  775. package/dist/tools/spans.d.ts.map +1 -0
  776. package/dist/tools/spans.js +77 -0
  777. package/dist/tools/spans.js.map +1 -0
  778. package/dist/tools/telemetry-wrapper.d.ts +4 -0
  779. package/dist/tools/telemetry-wrapper.d.ts.map +1 -0
  780. package/dist/tools/telemetry-wrapper.js +43 -0
  781. package/dist/tools/telemetry-wrapper.js.map +1 -0
  782. package/dist/viewer/cesdk-cdn.d.ts +16 -0
  783. package/dist/viewer/cesdk-cdn.d.ts.map +1 -0
  784. package/dist/viewer/cesdk-cdn.js +30 -0
  785. package/dist/viewer/cesdk-cdn.js.map +1 -0
  786. package/dist/viewer/router.d.ts +6 -0
  787. package/dist/viewer/router.d.ts.map +1 -1
  788. package/dist/viewer/router.js +4 -1
  789. package/dist/viewer/router.js.map +1 -1
  790. package/dist/viewer/spa-assets.generated.d.ts.map +1 -1
  791. package/dist/viewer/spa-assets.generated.js +2 -3
  792. package/dist/viewer/spa-assets.generated.js.map +1 -1
  793. package/dist/workspace/content-hash.d.ts +2 -0
  794. package/dist/workspace/content-hash.d.ts.map +1 -0
  795. package/dist/workspace/content-hash.js +15 -0
  796. package/dist/workspace/content-hash.js.map +1 -0
  797. package/package.json +18 -9
  798. package/assets/docs/guide/actions.md +0 -1038
  799. package/assets/docs/guide/animation/overview.md +0 -22
  800. package/assets/docs/guide/automation/batch-processing.md +0 -474
  801. package/assets/docs/guide/browser-support.md +0 -38
  802. package/assets/docs/guide/concepts/edit-modes.md +0 -431
  803. package/assets/docs/guide/concepts/headless-mode/browser.md +0 -291
  804. package/assets/docs/guide/create-audio/audio.md +0 -336
  805. package/assets/docs/guide/create-video/overview.md +0 -224
  806. package/assets/docs/guide/create-video/timeline-editor.md +0 -622
  807. package/assets/docs/guide/create-video/update-caption-presets.md +0 -676
  808. package/assets/docs/guide/edit-image/vectorize.md +0 -204
  809. package/assets/docs/guide/export-save-publish/export/to-html5.md +0 -474
  810. package/assets/docs/guide/export-save-publish/export/to-mp4.md +0 -364
  811. package/assets/docs/guide/get-started/vanilla-js/quickstart.md +0 -175
  812. package/assets/docs/guide/grid-and-rulers.md +0 -222
  813. package/assets/docs/guide/guides/text/rendering-internals.md +0 -796
  814. package/assets/docs/guide/import-media/asset-library.md +0 -23
  815. package/assets/docs/guide/import-media/asset-panel/basics.md +0 -324
  816. package/assets/docs/guide/import-media/asset-panel/customize.md +0 -478
  817. package/assets/docs/guide/import-media/asset-panel/thumbnails.md +0 -633
  818. package/assets/docs/guide/import-media/capture-from-camera/record-video.md +0 -137
  819. package/assets/docs/guide/import-media/capture-from-camera.md +0 -20
  820. package/assets/docs/guide/import-media/from-local-source/user-upload.md +0 -438
  821. package/assets/docs/guide/import-media/from-local-source.md +0 -20
  822. package/assets/docs/guide/import-media/from-remote-source/getty-images.md +0 -627
  823. package/assets/docs/guide/import-media/from-remote-source/imgly-premium-assets.md +0 -625
  824. package/assets/docs/guide/import-media/from-remote-source/pexels.md +0 -692
  825. package/assets/docs/guide/import-media/from-remote-source/soundstripe.md +0 -497
  826. package/assets/docs/guide/import-media/from-remote-source/third-party.md +0 -51
  827. package/assets/docs/guide/import-media/from-remote-source/unsplash.md +0 -914
  828. package/assets/docs/guide/import-media/from-remote-source/your-server.md +0 -764
  829. package/assets/docs/guide/open-the-editor/from-htmlcanvas.md +0 -228
  830. package/assets/docs/guide/open-the-editor/set-zoom-level.md +0 -303
  831. package/assets/docs/guide/plugins/asset-sources.md +0 -553
  832. package/assets/docs/guide/starterkits/3d-mockup-editor.md +0 -748
  833. package/assets/docs/guide/starterkits/advanced-editor.md +0 -698
  834. package/assets/docs/guide/starterkits/advanced-video-editor.md +0 -696
  835. package/assets/docs/guide/starterkits/ai-editor.md +0 -749
  836. package/assets/docs/guide/starterkits/airtable-image-editor.md +0 -672
  837. package/assets/docs/guide/starterkits/apparel-ui.md +0 -188
  838. package/assets/docs/guide/starterkits/assets.md +0 -27
  839. package/assets/docs/guide/starterkits/auto-resize.md +0 -586
  840. package/assets/docs/guide/starterkits/automated-video-generation.md +0 -692
  841. package/assets/docs/guide/starterkits/background-removal-editor.md +0 -480
  842. package/assets/docs/guide/starterkits/content-moderation.md +0 -863
  843. package/assets/docs/guide/starterkits/creative-automation.md +0 -28
  844. package/assets/docs/guide/starterkits/custom-built-uis.md +0 -26
  845. package/assets/docs/guide/starterkits/customization.md +0 -29
  846. package/assets/docs/guide/starterkits/cutout-lines-editor.md +0 -470
  847. package/assets/docs/guide/starterkits/data-merge.md +0 -850
  848. package/assets/docs/guide/starterkits/design-editor.md +0 -698
  849. package/assets/docs/guide/starterkits/design-generation.md +0 -719
  850. package/assets/docs/guide/starterkits/design-validation.md +0 -808
  851. package/assets/docs/guide/starterkits/editor-ui-configurations.md +0 -14
  852. package/assets/docs/guide/starterkits/export-options.md +0 -724
  853. package/assets/docs/guide/starterkits/export-using-renderer.md +0 -708
  854. package/assets/docs/guide/starterkits/extensibility.md +0 -28
  855. package/assets/docs/guide/starterkits/force-crop-editor.md +0 -675
  856. package/assets/docs/guide/starterkits/form-based-template-adoption.md +0 -522
  857. package/assets/docs/guide/starterkits/getty-images-editor.md +0 -700
  858. package/assets/docs/guide/starterkits/html5-ads-exporter.md +0 -719
  859. package/assets/docs/guide/starterkits/indesign-template-import.md +0 -580
  860. package/assets/docs/guide/starterkits/layouts-editor.md +0 -724
  861. package/assets/docs/guide/starterkits/mobile-ui.md +0 -185
  862. package/assets/docs/guide/starterkits/mockup-editor.md +0 -745
  863. package/assets/docs/guide/starterkits/multi-image-generation.md +0 -542
  864. package/assets/docs/guide/starterkits/page-sizes-editor.md +0 -657
  865. package/assets/docs/guide/starterkits/pexels-image-editor.md +0 -665
  866. package/assets/docs/guide/starterkits/photo-editor.md +0 -755
  867. package/assets/docs/guide/starterkits/photo-ui.md +0 -186
  868. package/assets/docs/guide/starterkits/photobook-ui.md +0 -188
  869. package/assets/docs/guide/starterkits/placeholders.md +0 -678
  870. package/assets/docs/guide/starterkits/player.md +0 -405
  871. package/assets/docs/guide/starterkits/plugins.md +0 -25
  872. package/assets/docs/guide/starterkits/postcard-editor.md +0 -202
  873. package/assets/docs/guide/starterkits/pptx-template-import.md +0 -581
  874. package/assets/docs/guide/starterkits/print-ready-pdf-editor.md +0 -746
  875. package/assets/docs/guide/starterkits/product-editor.md +0 -773
  876. package/assets/docs/guide/starterkits/psd-template-import.md +0 -580
  877. package/assets/docs/guide/starterkits/qr-code-editor.md +0 -470
  878. package/assets/docs/guide/starterkits/single-page-editor.md +0 -661
  879. package/assets/docs/guide/starterkits/start-with-image.md +0 -684
  880. package/assets/docs/guide/starterkits/start-with-video.md +0 -651
  881. package/assets/docs/guide/starterkits/t-shirt-designer.md +0 -742
  882. package/assets/docs/guide/starterkits/templating.md +0 -23
  883. package/assets/docs/guide/starterkits/theming.md +0 -662
  884. package/assets/docs/guide/starterkits/translation-internationalization.md +0 -662
  885. package/assets/docs/guide/starterkits/unsplash-editor.md +0 -839
  886. package/assets/docs/guide/starterkits/vectorizer-editor.md +0 -466
  887. package/assets/docs/guide/starterkits/version-history.md +0 -745
  888. package/assets/docs/guide/starterkits/video-animations.md +0 -853
  889. package/assets/docs/guide/starterkits/video-captions.md +0 -884
  890. package/assets/docs/guide/starterkits/video-editing.md +0 -25
  891. package/assets/docs/guide/starterkits/video-editor.md +0 -696
  892. package/assets/docs/guide/starterkits/video-export-options.md +0 -676
  893. package/assets/docs/guide/starterkits/viewer.md +0 -400
  894. package/assets/docs/guide/starterkits.md +0 -41
  895. package/assets/docs/guide/stickers-and-shapes/create-edit/vector-edit.md +0 -362
  896. package/assets/docs/guide/text/custom-fonts.md +0 -401
  897. package/assets/docs/guide/text/decorations.md +0 -330
  898. package/assets/docs/guide/text/enumerations.md +0 -258
  899. package/assets/docs/guide/to-v1-10.md +0 -131
  900. package/assets/docs/guide/to-v1-13.md +0 -165
  901. package/assets/docs/guide/to-v1-32.md +0 -110
  902. package/assets/docs/guide/to-v1-69.md +0 -468
  903. package/assets/docs/guide/to-v1-72.md +0 -193
  904. package/assets/docs/guide/use-templates/library.md +0 -450
  905. package/assets/docs/guide/user-interface/ai-integration/audio-generation.md +0 -428
  906. package/assets/docs/guide/user-interface/ai-integration/auto-captions.md +0 -337
  907. package/assets/docs/guide/user-interface/ai-integration/custom-provider.md +0 -853
  908. package/assets/docs/guide/user-interface/ai-integration/gateway-provider.md +0 -1045
  909. package/assets/docs/guide/user-interface/ai-integration/image-generation.md +0 -641
  910. package/assets/docs/guide/user-interface/ai-integration/integrate.md +0 -966
  911. package/assets/docs/guide/user-interface/ai-integration/proxy-server.md +0 -99
  912. package/assets/docs/guide/user-interface/ai-integration/text-generation.md +0 -498
  913. package/assets/docs/guide/user-interface/ai-integration/video-generation.md +0 -493
  914. package/assets/docs/guide/user-interface/ai-integration.md +0 -30
  915. package/assets/docs/guide/user-interface/appearance/change-ui-font.md +0 -316
  916. package/assets/docs/guide/user-interface/appearance/custom-labels.md +0 -509
  917. package/assets/docs/guide/user-interface/appearance/icons.md +0 -373
  918. package/assets/docs/guide/user-interface/appearance/theming.md +0 -665
  919. package/assets/docs/guide/user-interface/appearance.md +0 -23
  920. package/assets/docs/guide/user-interface/build-your-own-ui.md +0 -620
  921. package/assets/docs/guide/user-interface/customization/canvas-menu.md +0 -412
  922. package/assets/docs/guide/user-interface/customization/canvas.md +0 -281
  923. package/assets/docs/guide/user-interface/customization/color-palette.md +0 -413
  924. package/assets/docs/guide/user-interface/customization/crop-presets.md +0 -384
  925. package/assets/docs/guide/user-interface/customization/disable-or-enable.md +0 -676
  926. package/assets/docs/guide/user-interface/customization/dock.md +0 -399
  927. package/assets/docs/guide/user-interface/customization/force-crop.md +0 -289
  928. package/assets/docs/guide/user-interface/customization/inspector-bar.md +0 -371
  929. package/assets/docs/guide/user-interface/customization/navigation-bar.md +0 -516
  930. package/assets/docs/guide/user-interface/customization/page-format.md +0 -436
  931. package/assets/docs/guide/user-interface/customization/panel.md +0 -605
  932. package/assets/docs/guide/user-interface/customization/quick-start/add-action-buttons.md +0 -531
  933. package/assets/docs/guide/user-interface/customization/quick-start/add-dock-buttons.md +0 -358
  934. package/assets/docs/guide/user-interface/customization/quick-start/create-custom-components.md +0 -374
  935. package/assets/docs/guide/user-interface/customization/quick-start/reorder-components.md +0 -323
  936. package/assets/docs/guide/user-interface/customization/quick-start/show-hide-components.md +0 -294
  937. package/assets/docs/guide/user-interface/customization/quick-start.md +0 -12
  938. package/assets/docs/guide/user-interface/customization/reference/component-order-api.md +0 -519
  939. package/assets/docs/guide/user-interface/customization/reference/component-reference.md +0 -333
  940. package/assets/docs/guide/user-interface/customization/reference.md +0 -12
  941. package/assets/docs/guide/user-interface/customization.md +0 -39
  942. package/assets/docs/guide/user-interface/localization.md +0 -633
  943. package/assets/docs/guide/user-interface/overview.md +0 -167
  944. package/assets/docs/guide/user-interface/ui-extensions/add-custom-feature.md +0 -411
  945. package/assets/docs/guide/user-interface/ui-extensions/asset-library.md +0 -721
  946. package/assets/docs/guide/user-interface/ui-extensions/create-custom-panel.md +0 -331
  947. package/assets/docs/guide/user-interface/ui-extensions/customize-behaviour.md +0 -553
  948. package/assets/docs/guide/user-interface/ui-extensions/notifications-and-dialogs.md +0 -672
  949. package/assets/docs/guide/user-interface/ui-extensions/quick-actions.md +0 -415
  950. package/assets/docs/guide/user-interface/ui-extensions/register-new-component.md +0 -521
  951. package/assets/docs/guide/user-interface/ui-extensions.md +0 -26
  952. package/assets/docs/guide/user-interface.md +0 -25
  953. package/assets/prompts/evals-assetGenerate.md +0 -12
  954. package/assets/prompts/evals-brutalistCore.md +0 -34
  955. package/assets/prompts/evals-danskCatalogue.md +0 -31
  956. package/assets/prompts/evals-exportRoundTrip.md +0 -12
  957. package/assets/prompts/evals-inspectPriorCode.md +0 -16
  958. package/assets/prompts/evals-listProjectFiles.md +0 -6
  959. package/assets/prompts/evals-readAndExplainScript.md +0 -6
  960. package/assets/prompts/evals-resumeAcrossRestart.md +0 -15
  961. package/assets/prompts/evals-rewindRecovery.md +0 -10
  962. package/assets/prompts/evals-searchAcrossFiles.md +0 -6
  963. package/assets/prompts/evals-weddingCard.md +0 -20
  964. package/assets/prompts/explain.md +0 -6
  965. package/assets/prompts/review.md +0 -6
  966. package/dist/frontmatter.d.ts +0 -15
  967. package/dist/frontmatter.d.ts.map +0 -1
  968. package/dist/frontmatter.js +0 -46
  969. package/dist/frontmatter.js.map +0 -1
  970. package/dist/test/test/frontmatter.test.d.ts +0 -2
  971. package/dist/test/test/frontmatter.test.d.ts.map +0 -1
  972. package/dist/test/test/frontmatter.test.js +0 -55
  973. package/dist/test/test/frontmatter.test.js.map +0 -1
@@ -1,1038 +0,0 @@
1
- > This is one page of the CE.SDK Vanilla JS/TS documentation. For a complete overview, see the [Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
-
3
- **Navigation:** [Guides](./guides.md) > [Actions](./actions.md)
4
-
5
- ---
6
-
7
- The Actions API provides a centralized way to manage and customize actions for various user interactions in CE.SDK.
8
-
9
- > **Note:** The Actions API is available after CE.SDK initialization through
10
- > `cesdk.actions`.
11
-
12
- > **Tip:** CE.SDK also provides a Utils API (`cesdk.utils`) with utility functions for
13
- > common operations like exporting, file handling, and UI dialogs. These
14
- > utilities can be used directly or within your custom actions.
15
-
16
- ## API Methods
17
-
18
- The Actions API provides four methods:
19
-
20
- - `register(actionId, handler)` - Register an action function for a specific event
21
- - `get(actionId)` - Retrieve a registered action function
22
- - `run(actionId, ...args)` - Execute a registered action with the provided arguments (throws if not registered)
23
- - `list(matcher)` - Lists registered action IDs, optionally filtered by wildcard pattern
24
-
25
- ## Getting Started
26
-
27
- Register actions after initializing CE.SDK:
28
-
29
- ```javascript
30
- import CreativeEditorSDK from '@cesdk/cesdk-js';
31
-
32
- const cesdk = await CreativeEditorSDK.create(container, {
33
- // license: 'YOUR_CESDK_LICENSE_KEY',
34
- });
35
-
36
- // Register an action
37
- cesdk.actions.register('actionType', async (...args) => {
38
- // Your custom implementation
39
- return result;
40
- });
41
-
42
- // Execute a registered action
43
- await cesdk.actions.run('actionType', arg1, arg2);
44
-
45
- // Or retrieve an action to call it later
46
- const action = cesdk.actions.get('actionType');
47
-
48
- // List all registered actions
49
- const allActions = cesdk.actions.list();
50
-
51
- // List actions matching a pattern
52
- const exportActions = cesdk.actions.list({ matcher: 'export*' });
53
- ```
54
-
55
- ## Default Actions
56
-
57
- CE.SDK automatically registers the following default actions:
58
-
59
- ### Scene Creation
60
-
61
- - `scene.create` - Creates a new scene with configurable layout and page sizes
62
-
63
- ### Action Handlers
64
-
65
- - `saveScene` - Saves the current scene (default: downloads scene file)
66
- - `shareScene` - Shares the current scene (no default implementation)
67
- - `exportDesign` - Exports design in various formats (default: downloads the exported file)
68
- - `importScene` - Imports scene or archive files (default: opens file picker)
69
- - `exportScene` - Exports scene or archive (default: downloads the file)
70
- - `uploadFile` - Uploads files to asset sources (default: local upload for development)
71
- - `onUnsupportedBrowser` - Handles unsupported browsers (no default implementation)
72
- - `video.decode.checkSupport` - Checks video decoding/playback support (shows blocking dialog if unsupported)
73
- - `video.encode.checkSupport` - Checks video encoding/export support (shows warning dialog if unsupported)
74
-
75
- ### Zoom Actions
76
-
77
- - `zoom.toBlock` - Zoom to a specific block with configurable padding
78
- - `zoom.toPage` - Zoom to the current page with auto-fit support
79
- - `zoom.toSelection` - Zoom to currently selected blocks
80
- - `zoom.in` - Zoom in by one step with configurable maximum
81
- - `zoom.out` - Zoom out by one step with configurable minimum
82
- - `zoom.toLevel` - Set zoom to a specific level
83
-
84
- ### Scroll Actions
85
-
86
- - `scroll.toPage` - Scroll the viewport to center on a specific page with optional animation
87
-
88
- ### Video Timeline Zoom Actions
89
-
90
- - `timeline.zoom.in` - Zoom in the video timeline by one step
91
- - `timeline.zoom.out` - Zoom out the video timeline by one step
92
- - `timeline.zoom.fit` - Fit the video timeline to show all content
93
- - `timeline.zoom.toLevel` - Set the video timeline zoom to a specific level
94
- - `timeline.zoom.reset` - Reset the video timeline zoom to default (1.0)
95
-
96
- > **Note:** The `shareScene` and `onUnsupportedBrowser` actions do not have default
97
- > implementations and must be registered manually.
98
-
99
- > **Tip:** CE.SDK provides both an Actions API for handling user actions and a Utils API
100
- > for utility functions. See the Utils API section below for details on
101
- > available utilities.
102
-
103
- ### Scene Creation
104
-
105
- #### `scene.create`
106
-
107
- Creates a new scene with configurable mode, layout and page sizes. Returns the scene block ID.
108
-
109
- ```javascript
110
- // Create a scene
111
- await cesdk.actions.run('scene.create');
112
- ```
113
-
114
- **Options:**
115
-
116
- | Option | Type | Default | Description |
117
- | ----------- | ------------- | ----------------- | ----------------------------------------------------------------------------------------- |
118
- | `layout` | `SceneLayout` | `'VerticalStack'` | The scene layout. |
119
- | `page` | `PageSpec` | — | A single page specification. Cannot be used together with `pages`. |
120
- | `pageCount` | `number` | `1` | Number of pages to create from the single `page` spec. Ignored when `pages` is used. |
121
- | `pages` | `PageSpec[]` | — | An array of page specifications, one page per entry. Cannot be used together with `page`. |
122
-
123
- #### Page Specification
124
-
125
- Pages can be specified in three ways:
126
-
127
- **1. Direct dimensions**
128
-
129
- Specify width, height, and unit directly:
130
-
131
- ```javascript
132
- await cesdk.actions.run('scene.create', {
133
- page: { width: 1080, height: 1920, unit: 'Pixel' }
134
- });
135
-
136
- // With fixed orientation (prevents rotation from swapping dimensions)
137
- await cesdk.actions.run('scene.create', {
138
- page: { width: 1080, height: 1920, unit: 'Pixel', fixedOrientation: true }
139
- });
140
- ```
141
-
142
- **2. Asset source reference**
143
-
144
- Reference a page preset from an asset source by its source and asset IDs:
145
-
146
- ```javascript
147
- // Use an Instagram Story preset
148
- await cesdk.actions.run('scene.create', {
149
- page: {
150
- sourceId: 'ly.img.page.presets',
151
- assetId: 'ly.img.page.presets.instagram.story'
152
- }
153
- });
154
- ```
155
-
156
- **3. Asset object**
157
-
158
- Pass an asset object directly, for example one returned by `engine.asset.findAssets()`:
159
-
160
- ```javascript
161
- const result = await cesdk.engine.asset.findAssets('ly.img.page.presets', {
162
- query: ''
163
- });
164
- await cesdk.actions.run('scene.create', {
165
- page: result.assets[0]
166
- });
167
- ```
168
-
169
- #### Multiple Pages
170
-
171
- Create scenes with multiple pages:
172
-
173
- ```javascript
174
- // Multiple pages with different sizes
175
- await cesdk.actions.run('scene.create', {
176
- pages: [
177
- { width: 1080, height: 1920, unit: 'Pixel' },
178
- { width: 1920, height: 1080, unit: 'Pixel' }
179
- ]
180
- });
181
-
182
- // Multiple identical pages using pageCount
183
- await cesdk.actions.run('scene.create', {
184
- page: { width: 1080, height: 1080, unit: 'Pixel' },
185
- pageCount: 3
186
- });
187
- ```
188
-
189
- > **Tip:** When no `page` or `pages` option is provided, `scene.create` creates a single
190
- > page with the default format from the configured page preset asset sources.
191
-
192
- ### Scene Management Actions
193
-
194
- #### `saveScene`
195
-
196
- Handles saving the current scene. Default implementation downloads the scene file.
197
-
198
- ```javascript
199
- // Basic implementation
200
- cesdk.actions.register('saveScene', async () => {
201
- const scene = await cesdk.engine.scene.saveToString();
202
- console.log('Scene saved:', scene.length, 'characters');
203
-
204
- // Production:
205
- // await yourAPI.saveScene(scene);
206
-
207
- cesdk.ui.showNotification('Scene saved successfully');
208
- });
209
-
210
- // With loading dialog
211
- cesdk.actions.register('saveScene', async () => {
212
- const dialogController = cesdk.utils.showLoadingDialog({
213
- title: 'Saving Scene',
214
- message: 'Please wait...',
215
- progress: 'indeterminate'
216
- });
217
-
218
- try {
219
- const scene = await cesdk.engine.scene.saveToString();
220
- console.log('Scene saved:', scene.length, 'characters');
221
-
222
- // Production:
223
- // await yourAPI.saveScene(scene);
224
-
225
- dialogController.showSuccess({
226
- title: 'Saved',
227
- message: 'Scene saved successfully'
228
- });
229
- } catch (error) {
230
- dialogController.showError({
231
- title: 'Save Failed',
232
- message: 'Could not save the scene'
233
- });
234
- throw error;
235
- }
236
- });
237
- ```
238
-
239
- #### `shareScene`
240
-
241
- Handles scene sharing. No default implementation.
242
-
243
- ```javascript
244
- // Register share functionality
245
- cesdk.actions.register('shareScene', async () => {
246
- const scene = await cesdk.engine.scene.saveToString();
247
- const shareUrl = 'https://example.com/shared-scene-placeholder';
248
- console.log('Scene ready to share:', scene.length, 'characters');
249
-
250
- // Production:
251
- // const shareUrl = await yourAPI.createShareableLink(scene);
252
-
253
- await navigator.share({ url: shareUrl });
254
- });
255
- ```
256
-
257
- #### `importScene` and `exportScene`
258
-
259
- Handle scene import/export operations with support for both scene files and archives.
260
-
261
- ```javascript
262
- // Import scene or archive
263
- cesdk.actions.register('importScene', async ({ format }) => {
264
- if (format === 'archive') {
265
- console.log('Archive import requested');
266
-
267
- // Production:
268
- // const archive = await yourAPI.loadArchive();
269
- // await cesdk.engine.scene.loadFromArchiveURL(archive);
270
- } else {
271
- console.log('Scene import requested');
272
-
273
- // Production:
274
- // const scene = await yourAPI.loadScene();
275
- // await cesdk.engine.scene.loadFromString(scene);
276
- }
277
- });
278
-
279
- // Export scene or archive
280
- cesdk.actions.register('exportScene', async ({ format }) => {
281
- if (format === 'archive') {
282
- const archive = await cesdk.engine.scene.saveToArchive();
283
- console.log('Archive ready for export:', archive.length, 'bytes');
284
-
285
- // Production:
286
- // await yourAPI.uploadArchive(archive);
287
- } else {
288
- const scene = await cesdk.engine.scene.saveToString();
289
- console.log('Scene ready for export:', scene.length, 'characters');
290
-
291
- // Production:
292
- // await yourAPI.uploadScene(scene);
293
- }
294
- });
295
- ```
296
-
297
- ### Export Operations
298
-
299
- #### `exportDesign`
300
-
301
- Handles all export operations (images, PDFs, videos). Default implementation downloads the exported file.
302
-
303
- ```javascript
304
- // Basic implementation
305
- cesdk.actions.register('exportDesign', async (options) => {
306
- // Use the utils API to perform the export with loading dialog
307
- const { blobs, options: exportOptions } = await cesdk.utils.export(options);
308
- console.log('Exported', blobs.length, 'files');
309
- blobs.forEach((blob, i) => console.log(`File ${i + 1}:`, blob.size, 'bytes'));
310
-
311
- // Production:
312
- // await Promise.all(blobs.map(blob => yourCDN.upload(blob)));
313
-
314
- cesdk.ui.showNotification('Export completed successfully');
315
- });
316
-
317
- // Direct engine export with custom loading dialog (bypassing utils)
318
- cesdk.actions.register('exportDesign', async (options) => {
319
- const dialogController = cesdk.utils.showLoadingDialog({
320
- title: 'Exporting',
321
- message: 'Processing your export...'
322
- });
323
-
324
- try {
325
- const page = cesdk.engine.scene.getCurrentPage();
326
- if (page === null) {
327
- throw new Error('No page selected for export');
328
- }
329
- let result;
330
-
331
- if (options?.mimeType?.startsWith('video/')) {
332
- // Video export with progress
333
- result = await cesdk.engine.block.exportVideo(page, {
334
- ...options,
335
- onProgress: (rendered, encoded, total) => {
336
- dialogController.updateProgress({
337
- value: rendered,
338
- max: total
339
- });
340
- }
341
- });
342
- } else {
343
- // Static export (image/PDF)
344
- result = await cesdk.engine.block.export(page, options);
345
- }
346
-
347
- console.log('File ready for export:', result.size, 'bytes');
348
-
349
- // Production:
350
- // await yourCDN.upload(result);
351
-
352
- dialogController.showSuccess({
353
- title: 'Export Complete',
354
- message: 'Files uploaded successfully'
355
- });
356
- } catch (error) {
357
- dialogController.showError({
358
- title: 'Export Failed',
359
- message: 'Could not complete the export'
360
- });
361
- throw error;
362
- }
363
- });
364
- ```
365
-
366
- ### File Upload Action
367
-
368
- #### `uploadFile`
369
-
370
- Handles file uploads to asset sources. Default implementation uses local upload for development.
371
-
372
- ```javascript
373
- // Register production upload handler
374
- cesdk.actions.register('uploadFile', async (file, onProgress, context) => {
375
- console.log('Uploading file:', file.name, file.size, 'bytes');
376
- onProgress(50); // Simulate progress
377
- await new Promise((resolve) => setTimeout(resolve, 500));
378
- onProgress(100);
379
-
380
- // Production:
381
- // const asset = await yourStorageService.upload(file, {
382
- // onProgress: (percent) => onProgress(percent),
383
- // context
384
- // });
385
-
386
- // Return AssetDefinition
387
- return {
388
- id: 'local-' + Date.now(),
389
- label: { en: file.name },
390
- meta: {
391
- uri: URL.createObjectURL(file),
392
- thumbUri: URL.createObjectURL(file),
393
- kind: 'image',
394
- width: 1920,
395
- height: 1080
396
- // Production:
397
- // uri: asset.url,
398
- // thumbUri: asset.thumbnailUrl,
399
- // width: asset.width,
400
- // height: asset.height
401
- }
402
- };
403
- });
404
- ```
405
-
406
- You can control which file types users can upload by setting the `upload/supportedMimeTypes` setting:
407
-
408
- ```javascript
409
- // Example 1: Only allow images
410
- cesdk.engine.editor.setSettingString(
411
- 'upload/supportedMimeTypes',
412
- 'image/png,image/jpeg,image/gif,image/svg+xml'
413
- );
414
-
415
- // Example 2: Allow images and videos
416
- cesdk.engine.editor.setSettingString(
417
- 'upload/supportedMimeTypes',
418
- 'image/png,image/jpeg,image/gif,video/mp4,video/quicktime'
419
- );
420
-
421
- // Example 3: Allow specific document types
422
- cesdk.engine.editor.setSettingString(
423
- 'upload/supportedMimeTypes',
424
- 'application/pdf,image/png,image/jpeg'
425
- );
426
- ```
427
-
428
- > **Caution:** The default `uploadFile` implementation uses local upload for development
429
- > only. Always register a proper upload handler for production.
430
-
431
- ### Unsupported Browser Action
432
-
433
- #### `onUnsupportedBrowser`
434
-
435
- Handles unsupported browser detection. No default implementation is provided.
436
-
437
- ```javascript
438
- // Register handler for unsupported browsers
439
- cesdk.actions.register('onUnsupportedBrowser', () => {
440
- // Redirect to a custom compatibility page
441
- window.location.href = '/browser-not-supported';
442
- });
443
- ```
444
-
445
- ### Video Support Actions
446
-
447
- CE.SDK provides actions to detect video capabilities at runtime. These actions help you handle browsers and platforms that lack required video codecs, particularly Linux browsers and Firefox.
448
-
449
- #### `video.decode.checkSupport`
450
-
451
- Checks if the browser supports video decoding and playback via the WebCodecs API. If unsupported, displays a blocking error dialog that users cannot dismiss.
452
-
453
- Returns `true` if video decoding is supported, `false` otherwise.
454
-
455
- ```javascript
456
- // Check video decode support before loading video content
457
- const isSupported = cesdk.actions.run('video.decode.checkSupport');
458
-
459
- if (!isSupported) {
460
- // A blocking error dialog is shown automatically
461
- // The user cannot proceed with video editing
462
- return;
463
- }
464
-
465
- // Safe to proceed with video content
466
- await cesdk.engine.scene.loadFromURL(videoSceneUrl);
467
-
468
- // You can also disable the dialog and handle feedback yourself:
469
- const supportedSilently = cesdk.actions.run('video.decode.checkSupport', {
470
- dialog: false
471
- });
472
- ```
473
-
474
- **Options:**
475
-
476
- | Option | Type | Default | Description |
477
- | -------- | -------------------------------------------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------- |
478
- | `dialog` | `boolean \| { show: boolean; backdrop?: 'transparent' \| 'opaque' }` | `true` (backdrop: `'opaque'`) | Controls dialog display. Use `false` to disable, or an object for fine-grained control. |
479
-
480
- > **Caution:** The `video.decode.checkSupport` action shows a blocking dialog with no dismiss option
481
- > when video is not supported. Only call this action when you intend to work
482
- > with video content.
483
-
484
- #### `video.encode.checkSupport`
485
-
486
- Checks if the browser supports video encoding/export (H.264 video and AAC audio encoding). If unsupported, displays a warning dialog that users can dismiss to continue editing.
487
-
488
- Returns a `Promise<boolean>` - `true` if video encoding is supported, `false` otherwise.
489
-
490
- ```javascript
491
- // Check video encode support before attempting export
492
- const canExport = await cesdk.actions.run('video.encode.checkSupport');
493
-
494
- if (!canExport) {
495
- // A warning dialog is shown automatically
496
- // User can dismiss and continue editing
497
- // Consider offering server-side export as alternative
498
- console.log('Video export unavailable - consider server-side rendering');
499
- }
500
-
501
- // You can also disable the dialog and handle feedback yourself:
502
- const canExportSilently = await cesdk.actions.run('video.encode.checkSupport', {
503
- dialog: false
504
- });
505
- ```
506
-
507
- **Options:**
508
-
509
- | Option | Type | Default | Description |
510
- | -------- | -------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------- |
511
- | `dialog` | `boolean \| { show: boolean; backdrop?: 'transparent' \| 'opaque' }` | `true` (backdrop: `'transparent'`) | Controls dialog display. Use `false` to disable, or an object for fine-grained control. |
512
-
513
- > **Tip:** For platforms that don't support client-side video export (Linux, Firefox),
514
- > consider using [CE.SDK Renderer](#broken-link-7f3e9a)
515
- > for server-side video rendering.
516
-
517
- #### Platform Support
518
-
519
- | Platform | Video Import | Video Export |
520
- | ---------------------------- | ------------ | ------------ |
521
- | Chrome/Edge (Windows, macOS) | ✅ | ✅ |
522
- | Safari (macOS) | ✅ | ✅ |
523
- | Chrome (Linux) | ❌ | ❌ |
524
- | Firefox (all platforms) | ❌ | ❌ |
525
-
526
- ### Zoom Actions
527
-
528
- CE.SDK provides built-in zoom actions for controlling the viewport zoom level and focus. These actions are automatically registered and can be customized or called programmatically.
529
-
530
- #### Available Zoom Actions
531
-
532
- - `zoom.toBlock` - Zoom to a specific block with configurable padding
533
- - `zoom.toPage` - Zoom to the current page (or a specified page)
534
- - `zoom.toSelection` - Zoom to the currently selected blocks
535
- - `zoom.in` - Zoom in by one step
536
- - `zoom.out` - Zoom out by one step
537
- - `zoom.toLevel` - Set zoom to a specific level
538
-
539
- #### `zoom.toBlock`
540
-
541
- Zooms the viewport to fit a specific block.
542
-
543
- ```javascript
544
- // Zoom to a block with default settings
545
- await cesdk.actions.run('zoom.toBlock', blockId);
546
-
547
- // Zoom with custom padding and animation
548
- await cesdk.actions.run('zoom.toBlock', blockId, {
549
- padding: 50, // Uniform padding on all sides
550
- animate: true,
551
- autoFit: false
552
- });
553
-
554
- // Different padding for each side
555
- await cesdk.actions.run('zoom.toBlock', blockId, {
556
- padding: { top: 20, bottom: 20, left: 40, right: 40 },
557
- animate: {
558
- duration: 0.3,
559
- easing: 'EaseInOut'
560
- }
561
- });
562
- ```
563
-
564
- #### `zoom.toPage`
565
-
566
- Zooms to the current page or a specified page. If no options are provided, defaults to the current page.
567
-
568
- ```javascript
569
- // Zoom to current page with auto-fit
570
- await cesdk.actions.run('zoom.toPage', {
571
- autoFit: true,
572
- animate: false
573
- });
574
-
575
- // Zoom with custom padding
576
- await cesdk.actions.run('zoom.toPage', {
577
- padding: { x: 40, y: 80 },
578
- animate: true
579
- });
580
- ```
581
-
582
- #### `zoom.toSelection`
583
-
584
- Zooms to fit all currently selected blocks in the viewport.
585
-
586
- ```javascript
587
- // Zoom to selection with animation
588
- await cesdk.actions.run('zoom.toSelection', {
589
- padding: 40,
590
- animate: true
591
- });
592
-
593
- // Auto-fit to selection
594
- await cesdk.actions.run('zoom.toSelection', {
595
- autoFit: true,
596
- padding: { x: 20, y: 20 }
597
- });
598
- ```
599
-
600
- #### `zoom.in` and `zoom.out`
601
-
602
- Step-based zoom controls with configurable limits.
603
-
604
- ```javascript
605
- // Zoom in with default settings
606
- await cesdk.actions.run('zoom.in');
607
-
608
- // Zoom in with custom maximum
609
- await cesdk.actions.run('zoom.in', {
610
- maxZoom: 4, // Maximum zoom level
611
- animate: true
612
- });
613
-
614
- // Zoom out with custom minimum
615
- await cesdk.actions.run('zoom.out', {
616
- minZoom: 0.25, // Minimum zoom level
617
- animate: {
618
- duration: 0.2,
619
- easing: 'EaseOut'
620
- }
621
- });
622
- ```
623
-
624
- #### `zoom.toLevel`
625
-
626
- Sets the zoom to a specific level.
627
-
628
- ```javascript
629
- // Set zoom to 100%
630
- await cesdk.actions.run('zoom.toLevel', 1.0);
631
-
632
- // Set zoom to 200% with animation
633
- await cesdk.actions.run('zoom.toLevel', 2.0, {
634
- animate: true,
635
- minZoom: 0.125,
636
- maxZoom: 32
637
- });
638
-
639
- // Fit to width (50% zoom)
640
- await cesdk.actions.run('zoom.toLevel', 0.5, {
641
- animate: {
642
- duration: 0.3,
643
- easing: 'EaseInOut'
644
- }
645
- });
646
- ```
647
-
648
- #### Padding Options
649
-
650
- Padding can be specified in multiple ways:
651
-
652
- ```javascript
653
- // Uniform padding on all sides
654
- { padding: 20 }
655
-
656
- // Different horizontal and vertical padding
657
- { padding: { x: 40, y: 20 } }
658
-
659
- // Individual padding for each side
660
- { padding: { top: 10, bottom: 20, left: 30, right: 40 } }
661
- ```
662
-
663
- #### Animation Options
664
-
665
- Animation can be a boolean or an object with detailed settings:
666
-
667
- ```javascript
668
- // Simple animation toggle
669
- { animate: true } // Uses default duration and easing
670
- { animate: false } // No animation
671
-
672
- // Detailed animation configuration
673
- {
674
- animate: {
675
- duration: 0.3, // Duration in seconds
676
- easing: 'EaseInOut', // 'Linear', 'EaseIn', 'EaseOut', or 'EaseInOut'
677
- interruptible: true // Whether the animation can be interrupted
678
- }
679
- }
680
- ```
681
-
682
- #### Auto-Fit Mode
683
-
684
- The `autoFit` option enables automatic zoom adjustment when the viewport resizes:
685
-
686
- ```javascript
687
- // Enable auto-fit to maintain proper framing
688
- await cesdk.actions.run('zoom.toPage', {
689
- autoFit: true,
690
- padding: { x: 40, y: 80 }
691
- });
692
- ```
693
-
694
- When auto-fit is enabled, the zoom level will automatically adjust to keep the target properly framed when the viewport size changes.
695
-
696
- #### Custom Zoom Action Example
697
-
698
- You can override the default zoom actions with custom implementations:
699
-
700
- ```javascript
701
- // Custom zoom to page with analytics
702
- cesdk.actions.register('zoom.toPage', async (options) => {
703
- // Track zoom event
704
- console.log('User zoomed to page');
705
-
706
- // Get current page
707
- const currentPage = cesdk.engine.scene.getCurrentPage();
708
- if (!currentPage) return;
709
-
710
- // Apply custom zoom logic
711
- await cesdk.engine.scene.zoomToBlock(currentPage, {
712
- padding: options?.padding ?? { x: 50, y: 100 },
713
- animate: options?.animate ?? true
714
- });
715
-
716
- // Custom post-zoom behavior
717
- cesdk.ui.showNotification('Zoomed to page');
718
- });
719
- ```
720
-
721
- ### Video Timeline Zoom Actions
722
-
723
- The video timeline has its own set of zoom controls for managing the timeline view. These actions are registered when the video timeline component is active and provide instant zoom without animation.
724
-
725
- #### `timeline.zoom.in`
726
-
727
- Zooms in the video timeline by one step (multiplies current zoom level by 1.25).
728
-
729
- ```javascript
730
- // Zoom in the timeline
731
- await cesdk.actions.run('timeline.zoom.in');
732
- ```
733
-
734
- #### `timeline.zoom.out`
735
-
736
- Zooms out the video timeline by one step (divides current zoom level by 1.25).
737
-
738
- ```javascript
739
- // Zoom out the timeline
740
- await cesdk.actions.run('timeline.zoom.out');
741
- ```
742
-
743
- #### `timeline.zoom.fit`
744
-
745
- Automatically adjusts the timeline zoom to fit all content in the visible area.
746
-
747
- ```javascript
748
- // Fit timeline to show all content
749
- await cesdk.actions.run('timeline.zoom.fit');
750
- ```
751
-
752
- #### `timeline.zoom.toLevel`
753
-
754
- Sets the timeline zoom to a specific level.
755
-
756
- ```javascript
757
- // Set timeline zoom to 100%
758
- await cesdk.actions.run('timeline.zoom.toLevel', 1.0);
759
-
760
- // Set timeline zoom to 150%
761
- await cesdk.actions.run('timeline.zoom.toLevel', 1.5);
762
-
763
- // Set timeline zoom to 50%
764
- await cesdk.actions.run('timeline.zoom.toLevel', 0.5);
765
- ```
766
-
767
- #### `timeline.zoom.reset`
768
-
769
- Resets the timeline zoom to the default level (1.0 or 100%).
770
-
771
- ```javascript
772
- // Reset timeline zoom to default
773
- await cesdk.actions.run('timeline.zoom.reset');
774
- ```
775
-
776
- ### Scroll Actions
777
-
778
- CE.SDK provides a scroll action for panning the viewport to different pages without changing the zoom level. This is useful for multi-page navigation where you want to maintain the current zoom.
779
-
780
- #### `scroll.toPage`
781
-
782
- Scrolls the viewport to center on a specific page without changing the zoom level.
783
-
784
- ```javascript
785
- // Scroll to current page without animation
786
- await cesdk.actions.run('scroll.toPage');
787
-
788
- // Scroll to current page with smooth animation
789
- await cesdk.actions.run('scroll.toPage', {
790
- animate: true
791
- });
792
-
793
- // Scroll to a specific page
794
- await cesdk.actions.run('scroll.toPage', {
795
- pageId: myPageId,
796
- animate: true
797
- });
798
- ```
799
-
800
- #### Parameters
801
-
802
- The `scroll.toPage` action accepts an optional options object:
803
-
804
- - `pageId` (optional): The ID of the page to scroll to. If not provided, scrolls to the current page.
805
- - `animate` (optional): Whether to animate the scroll transition. Default is `false`.
806
-
807
- #### Scroll vs Zoom
808
-
809
- The key difference between `scroll.toPage` and `zoom.toPage`:
810
-
811
- - **`scroll.toPage`**: Pans the viewport to center on the page while maintaining the current zoom level
812
- - **`zoom.toPage`**: Adjusts the zoom level to fit the page within the viewport with padding
813
-
814
- Use `scroll.toPage` when you want to navigate between pages in a multi-page document while keeping the same zoom level. Use `zoom.toPage` when you want to frame a page properly within the viewport.
815
-
816
- ## Utils API
817
-
818
- CE.SDK provides a Utils API with utility functions for common operations. These utilities are available through `cesdk.utils`:
819
-
820
- ### Loading Dialogs
821
-
822
- ```javascript
823
- // Create and manage loading dialogs
824
- const dialogController = cesdk.utils.showLoadingDialog({
825
- title: 'Processing...',
826
- message: 'Please wait', // Can also be an array of strings
827
- progress: 0, // Initial progress value or 'indeterminate'
828
- cancelLabel: 'Cancel',
829
- abortTitle: 'Abort Operation?',
830
- abortMessage: 'Are you sure you want to abort?',
831
- abortLabel: 'Abort',
832
- size: 'large', // 'regular' or 'large'
833
- clickOutsideToClose: false,
834
- onAbort: () => console.log('User cancelled'),
835
- onDone: () => console.log('Dialog closed')
836
- });
837
-
838
- // Update progress
839
- dialogController.updateProgress({ value: 50, max: 100 });
840
-
841
- // Show success or error
842
- dialogController.showSuccess({
843
- title: 'Done!',
844
- message: 'Operation completed'
845
- });
846
- dialogController.showError({ title: 'Error', message: 'Something went wrong' });
847
-
848
- // Close dialog
849
- dialogController.close();
850
- ```
851
-
852
- ### Export Utility
853
-
854
- The export utility automatically handles both static (images, PDFs) and video exports:
855
-
856
- ```javascript
857
- // Export image or PDF
858
- const { blobs, options } = await cesdk.utils.export({
859
- mimeType: 'image/png',
860
- pngCompressionLevel: 7
861
- });
862
-
863
- // Export video (automatically detected by MIME type)
864
- const { blobs, options } = await cesdk.utils.export({
865
- mimeType: 'video/mp4',
866
- onProgress: (rendered, encoded, total) => {
867
- console.log(`Progress: ${rendered}/${total} frames`);
868
- }
869
- });
870
- ```
871
-
872
- ### File Operations
873
-
874
- ```javascript
875
- // Load file from user
876
- const file = await cesdk.utils.loadFile({
877
- accept: 'image/*',
878
- returnType: 'File' // 'dataURL', 'objectURL', 'text', 'blob', 'arrayBuffer', or 'File'
879
- });
880
-
881
- // Download file to user's device
882
- await cesdk.utils.downloadFile(blob, 'image/png');
883
-
884
- // Local upload (development only)
885
- const asset = await cesdk.utils.localUpload(file, context);
886
- ```
887
-
888
- ### Video Support Detection
889
-
890
- Check browser video capabilities before working with video content:
891
-
892
- ```javascript
893
- // Check if video decoding/playback is supported
894
- if (cesdk.utils.supportsVideoDecode()) {
895
- // Safe to load and play video content
896
- await cesdk.engine.scene.loadFromURL(videoSceneUrl);
897
- } else {
898
- // Show fallback UI or message
899
- console.log('Video playback not available in this browser');
900
- }
901
-
902
- // Check if video encoding/export is supported (async)
903
- if (await cesdk.utils.supportsVideoEncode()) {
904
- // Video export is available
905
- const blob = await cesdk.engine.block.exportVideo(page);
906
- } else {
907
- // Suggest server-side rendering alternative
908
- console.log('Video export not available - consider using CE.SDK Renderer');
909
- }
910
- ```
911
-
912
- These utilities provide the same checks as the `video.decode.checkSupport` and `video.encode.checkSupport` actions, but without showing dialogs. Use them when you want to check support silently and handle the UI yourself.
913
-
914
- ## Implementation Examples
915
-
916
- ### Environment-Based Upload Strategy
917
-
918
- ```javascript
919
- // Use local upload in development, CDN in production
920
- cesdk.actions.register('uploadFile', async (file, onProgress, context) => {
921
- if (process.env.NODE_ENV === 'development') {
922
- // Use utils for local upload
923
- return await cesdk.utils.localUpload(file, context);
924
- } else {
925
- console.log('Production upload for:', file.name);
926
- onProgress(100);
927
-
928
- // Production:
929
- // const asset = await yourCDNService.upload(file, {
930
- // onProgress: onProgress
931
- // });
932
-
933
- return {
934
- id: 'prod-' + Date.now(),
935
- label: { en: file.name },
936
- meta: {
937
- uri: URL.createObjectURL(file),
938
- thumbUri: URL.createObjectURL(file)
939
- // Production:
940
- // uri: asset.url,
941
- // thumbUri: asset.thumbnailUrl
942
- }
943
- };
944
- }
945
- });
946
- ```
947
-
948
- ### Combining Utils with Custom Logic
949
-
950
- ```javascript
951
- // Use utils for heavy lifting, add custom business logic
952
- cesdk.actions.register('exportDesign', async (options) => {
953
- console.log('Export started:', { format: options?.mimeType });
954
-
955
- // Production:
956
- // analytics.track('export_started', { format: options?.mimeType });
957
-
958
- // Use utils to handle the export with loading dialog
959
- const { blobs, options: exportOptions } = await cesdk.utils.export(options);
960
-
961
- // Custom post-processing
962
- if (exportOptions.mimeType === 'application/pdf') {
963
- console.log('PDF ready for watermarking:', blobs[0].size, 'bytes');
964
-
965
- // Production:
966
- // const watermarkedBlob = await addWatermark(blobs[0]);
967
- // await cesdk.utils.downloadFile(watermarkedBlob, 'application/pdf');
968
-
969
- await cesdk.utils.downloadFile(blobs[0], 'application/pdf');
970
- } else {
971
- // Direct download for other formats
972
- await cesdk.utils.downloadFile(blobs[0], exportOptions.mimeType);
973
- }
974
-
975
- console.log('Export completed:', { format: exportOptions.mimeType });
976
-
977
- // Production:
978
- // analytics.track('export_completed', { format: exportOptions.mimeType });
979
- });
980
- ```
981
-
982
- ## Registering Custom Actions with Custom IDs
983
-
984
- Beyond the predefined action types, you can register actions with custom IDs for your own application-specific needs:
985
-
986
- ```javascript
987
- // Register a custom action
988
- cesdk.actions.register('myCustomAction', async (data) => {
989
- console.log('Custom action triggered with:', data);
990
- return { success: true, processedData: data };
991
- });
992
-
993
- // Execute the custom action using run
994
- const result = await cesdk.actions.run('myCustomAction', { someData: 'value' });
995
-
996
- // Or retrieve it for conditional execution
997
- const customAction = cesdk.actions.get('myCustomAction');
998
- if (customAction) {
999
- const result = await customAction({ someData: 'value' });
1000
- }
1001
- ```
1002
-
1003
- ## Discovering Registered Actions
1004
-
1005
- Use `list()` to get all registered action IDs or find actions matching a pattern:
1006
-
1007
- ```javascript
1008
- // Get all registered action IDs
1009
- const registeredActions = cesdk.actions.list();
1010
- console.log('Available actions:', registeredActions);
1011
-
1012
- // Find actions matching a pattern
1013
- const exportActions = cesdk.actions.list({ matcher: 'export*' });
1014
- console.log('Export actions:', exportActions);
1015
- ```
1016
-
1017
- ## Using Actions with Navigation Actions
1018
-
1019
- The navigation bar actions in CE.SDK automatically use the registered actions:
1020
-
1021
- ### Default Navigation Bar Actions
1022
-
1023
- The default navigation bar actions map to actions:
1024
-
1025
- - Save action → `saveScene` action
1026
- - Share action → `shareScene` action
1027
- - Export actions → `exportDesign` action
1028
- - Import scene/archive → `importScene` action
1029
- - Export scene/archive → `exportScene` action
1030
-
1031
- ---
1032
-
1033
- ## More Resources
1034
-
1035
- - **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
1036
- - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
1037
- - **[Web Documentation](./js.md)** - Interactive documentation with examples
1038
- - **[Support](mailto:support@img.ly)** - Contact IMG.LY support