@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.
- package/README.md +51 -1
- package/assets/docs/guide/SKILL.md +45 -53
- package/assets/docs/guide/animation/create/base.md +234 -243
- package/assets/docs/guide/animation/create/text.md +250 -231
- package/assets/docs/guide/animation/create.md +197 -231
- package/assets/docs/guide/animation/edit.md +196 -271
- package/assets/docs/guide/animation/types.md +182 -185
- package/assets/docs/guide/animation.md +9 -6
- package/assets/docs/guide/api/AssetAPI.md +7 -53
- package/assets/docs/guide/api/BlockAPI.md +725 -648
- package/assets/docs/guide/api/CreativeEngine.md +7 -16
- package/assets/docs/guide/api/EditorAPI.md +32 -93
- package/assets/docs/guide/api/EventAPI.md +1 -2
- package/assets/docs/guide/api/SceneAPI.md +47 -98
- package/assets/docs/guide/api/VariableAPI.md +1 -4
- package/assets/docs/guide/api/node/classes/assetapi.md +1090 -0
- package/assets/docs/guide/api/node/classes/blockapi.md +12965 -0
- package/assets/docs/guide/api/node/classes/creativeengine.md +319 -0
- package/assets/docs/guide/api/node/classes/editorapi.md +3417 -0
- package/assets/docs/guide/api/node/classes/engineactions.md +319 -0
- package/assets/docs/guide/api/node/classes/eventapi.md +56 -0
- package/assets/docs/guide/api/node/classes/sceneapi.md +1370 -0
- package/assets/docs/guide/api/node/classes/variableapi.md +143 -0
- package/assets/docs/guide/api/node/enumerations/compressionformat.md +23 -0
- package/assets/docs/guide/api/node/enumerations/compressionlevel.md +24 -0
- package/assets/docs/guide/api/node/functions/iscmykcolor.md +30 -0
- package/assets/docs/guide/api/node/functions/isrgbacolor.md +30 -0
- package/assets/docs/guide/api/node/functions/isspotcolor.md +30 -0
- package/assets/docs/guide/api/node/interfaces/addvideooptions.md +31 -0
- package/assets/docs/guide/api/node/interfaces/applyassetoptions.md +31 -0
- package/assets/docs/guide/api/node/interfaces/asset.md +30 -0
- package/assets/docs/guide/api/node/interfaces/assetbooleanproperty.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetcmykcolor.md +26 -0
- package/assets/docs/guide/api/node/interfaces/assetcolorproperty.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetcontentaspectratio.md +23 -0
- package/assets/docs/guide/api/node/interfaces/assetdefinition.md +31 -0
- package/assets/docs/guide/api/node/interfaces/assetenumproperty.md +26 -0
- package/assets/docs/guide/api/node/interfaces/assetfixedaspectratio.md +24 -0
- package/assets/docs/guide/api/node/interfaces/assetfixedsize.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetfreeaspectratio.md +22 -0
- package/assets/docs/guide/api/node/interfaces/assetnumberproperty.md +28 -0
- package/assets/docs/guide/api/node/interfaces/assetpayload.md +27 -0
- package/assets/docs/guide/api/node/interfaces/assetquerydata.md +32 -0
- package/assets/docs/guide/api/node/interfaces/assetresult.md +46 -0
- package/assets/docs/guide/api/node/interfaces/assetrgbcolor.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetsource.md +111 -0
- package/assets/docs/guide/api/node/interfaces/assetspotcolor.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetsqueryresult.md +31 -0
- package/assets/docs/guide/api/node/interfaces/assetstringproperty.md +25 -0
- package/assets/docs/guide/api/node/interfaces/assetstylepreset.md +39 -0
- package/assets/docs/guide/api/node/interfaces/assetstylepresetanimation.md +23 -0
- package/assets/docs/guide/api/node/interfaces/audiotrackinfo.md +32 -0
- package/assets/docs/guide/api/node/interfaces/blockevent.md +26 -0
- package/assets/docs/guide/api/node/interfaces/blockstateerror.md +26 -0
- package/assets/docs/guide/api/node/interfaces/blockstatepending.md +26 -0
- package/assets/docs/guide/api/node/interfaces/blockstateready.md +25 -0
- package/assets/docs/guide/api/node/interfaces/buffer.md +26 -0
- package/assets/docs/guide/api/node/interfaces/characterinkbox.md +29 -0
- package/assets/docs/guide/api/node/interfaces/cmykcolor.md +34 -0
- package/assets/docs/guide/api/node/interfaces/completeassetresult.md +46 -0
- package/assets/docs/guide/api/node/interfaces/configuration.md +38 -0
- package/assets/docs/guide/api/node/interfaces/dominantcolor.md +25 -0
- package/assets/docs/guide/api/node/interfaces/dominantcolorsoptions.md +23 -0
- package/assets/docs/guide/api/node/interfaces/engineactioninfo.md +24 -0
- package/assets/docs/guide/api/node/interfaces/engineactionsregistry.md +18 -0
- package/assets/docs/guide/api/node/interfaces/engineplugin.md +30 -0
- package/assets/docs/guide/api/node/interfaces/font.md +27 -0
- package/assets/docs/guide/api/node/interfaces/fontmetrics.md +32 -0
- package/assets/docs/guide/api/node/interfaces/gradientcolorstop.md +28 -0
- package/assets/docs/guide/api/node/interfaces/logger.md +39 -0
- package/assets/docs/guide/api/node/interfaces/pageduration.md +23 -0
- package/assets/docs/guide/api/node/interfaces/range.md +23 -0
- package/assets/docs/guide/api/node/interfaces/rgbacolor.md +32 -0
- package/assets/docs/guide/api/node/interfaces/rgbcolor.md +30 -0
- package/assets/docs/guide/api/node/interfaces/settings.md +126 -0
- package/assets/docs/guide/api/node/interfaces/size2.md +21 -0
- package/assets/docs/guide/api/node/interfaces/source.md +24 -0
- package/assets/docs/guide/api/node/interfaces/spotcolor.md +30 -0
- package/assets/docs/guide/api/node/interfaces/textdecorationconfig.md +31 -0
- package/assets/docs/guide/api/node/interfaces/textfontsizeoptions.md +24 -0
- package/assets/docs/guide/api/node/interfaces/textruninfo.md +33 -0
- package/assets/docs/guide/api/node/interfaces/transientresource.md +26 -0
- package/assets/docs/guide/api/node/interfaces/typeface.md +23 -0
- package/assets/docs/guide/api/node/interfaces/vec2.md +21 -0
- package/assets/docs/guide/api/node/interfaces/vec3.md +22 -0
- package/assets/docs/guide/api/node/type-aliases/addimageoptions.md +36 -0
- package/assets/docs/guide/api/node/type-aliases/animationbaselinedirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationblockswipetextdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationeasing.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationentry.md +28 -0
- package/assets/docs/guide/api/node/type-aliases/animationgrowdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationjumploopdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationkenburnsdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationmergetextdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationoptions.md +28 -0
- package/assets/docs/guide/api/node/type-aliases/animationspindirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationspinloopdirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationtype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/animationtypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/animationtypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationtypewritertextwritingstyle.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/animationwipedirection.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/applicationmimetype.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/assetcolor.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/assetfilter.md +47 -0
- package/assets/docs/guide/api/node/type-aliases/assetgroups.md +25 -0
- package/assets/docs/guide/api/node/type-aliases/assetmetadata.md +42 -0
- package/assets/docs/guide/api/node/type-aliases/assetproperty.md +25 -0
- package/assets/docs/guide/api/node/type-aliases/assetpropertyfilter.md +41 -0
- package/assets/docs/guide/api/node/type-aliases/assetpropertypath.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/assetstylepresetanimationproperties.md +34 -0
- package/assets/docs/guide/api/node/type-aliases/assetstylepresetproperties.md +29 -0
- package/assets/docs/guide/api/node/type-aliases/assetstylepresetpropertyvalue.md +29 -0
- package/assets/docs/guide/api/node/type-aliases/assetstylepresetscalableproperty.md +28 -0
- package/assets/docs/guide/api/node/type-aliases/assettransformpreset.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/asyncuriresolver.md +36 -0
- package/assets/docs/guide/api/node/type-aliases/audioexportoptions.md +43 -0
- package/assets/docs/guide/api/node/type-aliases/audiofromvideooptions.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/audiomimetype.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/blendmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/blockenumtype.md +63 -0
- package/assets/docs/guide/api/node/type-aliases/blockstate.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/blurtype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/blurtypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/blurtypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/booleanoperation.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/boolpropertyname.md +79 -0
- package/assets/docs/guide/api/node/type-aliases/cameraclampingovershootmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/captionhorizontalalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/captionverticalalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/cmyk.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/color.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/colorpickercolormode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/colorpropertyname.md +31 -0
- package/assets/docs/guide/api/node/type-aliases/colorspace.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/contentfillmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/controlgizmomovehandlevisibility.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/controlgizmoresizehandlesvisibility.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/controlgizmorotatehandlesvisibility.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/controlgizmoscalehandlesvisibility.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/createsceneoptions.md +30 -0
- package/assets/docs/guide/api/node/type-aliases/cutoutoperation.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/cutouttype.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/defaultassetsourceid.md +37 -0
- package/assets/docs/guide/api/node/type-aliases/demoassetsourceid.md +33 -0
- package/assets/docs/guide/api/node/type-aliases/designblockid.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/designblocktype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/designblocktypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/designblocktypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/designunit.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/doubleclickselectionmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/doublepropertyname.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/dropshadowoptions.md +32 -0
- package/assets/docs/guide/api/node/type-aliases/editmode.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/effecttype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/effecttypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/effecttypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/engineactionid.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/enginecustomactionfunction.md +30 -0
- package/assets/docs/guide/api/node/type-aliases/engineplugincontext.md +30 -0
- package/assets/docs/guide/api/node/type-aliases/enumpropertyname.md +59 -0
- package/assets/docs/guide/api/node/type-aliases/enumvalues.md +59 -0
- package/assets/docs/guide/api/node/type-aliases/exportoptions.md +57 -0
- package/assets/docs/guide/api/node/type-aliases/fillpixelstreamorientation.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/filltype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/filltypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/filltypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/floatpropertyname.md +184 -0
- package/assets/docs/guide/api/node/type-aliases/fontsizeunit.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/fontstyle.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/fontweight.md +30 -0
- package/assets/docs/guide/api/node/type-aliases/gradientstoprgba.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/heightmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/hexcolorstring.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/historyid.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/historyupdate.md +25 -0
- package/assets/docs/guide/api/node/type-aliases/horizontalblockalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/horizontalcontentfillalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/horizontaltextalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/imagemimetype.md +25 -0
- package/assets/docs/guide/api/node/type-aliases/intpropertyname.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/liststyle.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/locale.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/loglevel.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/mimetype.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/objecttype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/objecttypelonghand.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/objecttypeshorthand.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/optionalprefix.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/pageguidessource.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/palettecolor.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/positionmode.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/positionxmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/positionymode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/propertytype.md +31 -0
- package/assets/docs/guide/api/node/type-aliases/rgba.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/rolestring.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/scenefontsizeunit.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/scenelayout.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/scenemode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/scope.md +50 -0
- package/assets/docs/guide/api/node/type-aliases/settingboolpropertyname.md +62 -0
- package/assets/docs/guide/api/node/type-aliases/settingcolorpropertyname.md +38 -0
- package/assets/docs/guide/api/node/type-aliases/settingenumpropertyname.md +29 -0
- package/assets/docs/guide/api/node/type-aliases/settingenumtype.md +33 -0
- package/assets/docs/guide/api/node/type-aliases/settingenumvalues.md +29 -0
- package/assets/docs/guide/api/node/type-aliases/settingfloatpropertyname.md +25 -0
- package/assets/docs/guide/api/node/type-aliases/settingintpropertyname.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingkey.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/settingsbool.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingscolor.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/settingscolorrgba.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/settingsenum.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingsfloat.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingsint.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingsstring.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/settingstringpropertyname.md +28 -0
- package/assets/docs/guide/api/node/type-aliases/settingtype.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/settingvaluetype.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/shapetype.md +24 -0
- package/assets/docs/guide/api/node/type-aliases/shapetypelonghand.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/shapetypeshorthand.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/shapevectorpathfillrule.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/sizemode.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/sortingorder.md +21 -0
- package/assets/docs/guide/api/node/type-aliases/sourcesetpropertyname.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/splitoptions.md +28 -0
- package/assets/docs/guide/api/node/type-aliases/stringpropertyname.md +43 -0
- package/assets/docs/guide/api/node/type-aliases/strokecap.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokecornergeometry.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokedashendcap.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokedashstartcap.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokeendcap.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokeposition.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokestartcap.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/strokestyle.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/syncuriresolver.md +31 -0
- package/assets/docs/guide/api/node/type-aliases/textanimationwritingstyle.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/textcase.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/textdecorationline.md +27 -0
- package/assets/docs/guide/api/node/type-aliases/textdecorationstyle.md +26 -0
- package/assets/docs/guide/api/node/type-aliases/textverticalalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/timelinetrackvisibility.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/touchpinchaction.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/touchrotateaction.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/typefacedefinition.md +41 -0
- package/assets/docs/guide/api/node/type-aliases/verticalblockalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/verticalcontentfillalignment.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/videoexportoptions.md +54 -0
- package/assets/docs/guide/api/node/type-aliases/videomimetype.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/widthmode.md +18 -0
- package/assets/docs/guide/api/node/type-aliases/xywh.md +23 -0
- package/assets/docs/guide/api/node/type-aliases/zoomautofitaxis.md +20 -0
- package/assets/docs/guide/api/node/type-aliases/zoomoptions.md +27 -0
- package/assets/docs/guide/api/node/variables/animation_types.md +21 -0
- package/assets/docs/guide/api/node/variables/animationbaselinedirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationblockswipetextdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationeasingvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationgrowdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationjumploopdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationkenburnsdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationmergetextdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationspindirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationspinloopdirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationtypewritertextwritingstylevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/animationwipedirectionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/blendmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/blur_types.md +21 -0
- package/assets/docs/guide/api/node/variables/cameraclampingovershootmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/captionhorizontalalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/captionverticalalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/colorpickercolormodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/contentfillmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/controlgizmomovehandlevisibilityvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/controlgizmoresizehandlesvisibilityvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/controlgizmorotatehandlesvisibilityvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/controlgizmoscalehandlesvisibilityvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/cutouttypevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/design_block_types.md +21 -0
- package/assets/docs/guide/api/node/variables/doubleclickselectionmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/effect_types.md +21 -0
- package/assets/docs/guide/api/node/variables/fill_types.md +21 -0
- package/assets/docs/guide/api/node/variables/fillpixelstreamorientationvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/heightmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/horizontalcontentfillalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/loglevel.md +37 -0
- package/assets/docs/guide/api/node/variables/mimetype.md +41 -0
- package/assets/docs/guide/api/node/variables/pageguidessourcevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/positionxmodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/positionymodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/scenedesignunitvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/scenefontsizeunitvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/scenelayoutvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/scenemodevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/shape_types.md +21 -0
- package/assets/docs/guide/api/node/variables/shapevectorpathfillrulevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokecapvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokecornergeometryvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokedashendcapvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokedashstartcapvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokeendcapvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokepositionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokestartcapvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/strokestylevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/textanimationwritingstylevalues.md +18 -0
- package/assets/docs/guide/api/node/variables/texthorizontalalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/textverticalalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/timelinetrackvisibilityvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/touchpinchactionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/touchrotateactionvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/verticalcontentfillalignmentvalues.md +18 -0
- package/assets/docs/guide/api/node/variables/widthmodevalues.md +18 -0
- package/assets/docs/guide/api/types.md +5 -9
- package/assets/docs/guide/api-reference/overview.md +7 -7
- package/assets/docs/guide/automation/auto-resize.md +263 -300
- package/assets/docs/guide/automation/data-merge.md +246 -275
- package/assets/docs/guide/automation/design-generation.md +102 -31
- package/assets/docs/guide/automation/multi-image-generation.md +758 -0
- package/assets/docs/guide/automation/overview.md +21 -4
- package/assets/docs/guide/automation.md +10 -5
- package/assets/docs/guide/capabilities.md +6 -4
- package/assets/docs/guide/colors/adjust.md +247 -249
- package/assets/docs/guide/colors/apply.md +127 -138
- package/assets/docs/guide/colors/basics.md +126 -150
- package/assets/docs/guide/colors/conversion.md +171 -177
- package/assets/docs/guide/colors/create-color-palette.md +244 -245
- package/assets/docs/guide/colors/extract-colors.md +144 -0
- package/assets/docs/guide/colors/for-print/cmyk.md +292 -352
- package/assets/docs/guide/colors/for-print/spot.md +521 -578
- package/assets/docs/guide/colors/for-print.md +9 -4
- package/assets/docs/guide/colors/for-screen/p3.md +12 -10
- package/assets/docs/guide/colors/for-screen/srgb.md +107 -133
- package/assets/docs/guide/colors/for-screen.md +9 -4
- package/assets/docs/guide/colors/overview.md +6 -4
- package/assets/docs/guide/colors/replace.md +381 -419
- package/assets/docs/guide/colors.md +9 -4
- package/assets/docs/guide/compatibility.md +7 -5
- package/assets/docs/guide/concepts/architecture.md +17 -15
- package/assets/docs/guide/concepts/assets.md +152 -140
- package/assets/docs/guide/concepts/blocks.md +227 -323
- package/assets/docs/guide/concepts/buffers.md +147 -276
- package/assets/docs/guide/concepts/design-units.md +95 -145
- package/assets/docs/guide/concepts/editing-workflow.md +69 -183
- package/assets/docs/guide/concepts/events.md +80 -122
- package/assets/docs/guide/concepts/headless-mode.md +237 -0
- package/assets/docs/guide/concepts/pages.md +137 -127
- package/assets/docs/guide/concepts/resources.md +156 -217
- package/assets/docs/guide/concepts/scenes.md +191 -210
- package/assets/docs/guide/concepts/templating.md +118 -74
- package/assets/docs/guide/concepts/terminology.md +49 -47
- package/assets/docs/guide/concepts/undo-and-history.md +229 -303
- package/assets/docs/guide/concepts.md +9 -7
- package/assets/docs/guide/configuration.md +252 -380
- package/assets/docs/guide/conversion/overview.md +33 -4
- package/assets/docs/guide/conversion/to-base64.md +127 -167
- package/assets/docs/guide/conversion/to-pdf.md +24 -474
- package/assets/docs/guide/conversion/to-png.md +168 -211
- package/assets/docs/guide/conversion.md +9 -4
- package/assets/docs/guide/create-audio/audio/add-music.md +301 -327
- package/assets/docs/guide/create-audio/audio/add-sound-effects.md +475 -359
- package/assets/docs/guide/create-audio/audio/loop.md +232 -272
- package/assets/docs/guide/create-composition/add-background.md +237 -239
- package/assets/docs/guide/create-composition/blend-modes.md +118 -209
- package/assets/docs/guide/create-composition/collage.md +538 -320
- package/assets/docs/guide/create-composition/group-and-ungroup.md +216 -261
- package/assets/docs/guide/create-composition/layer-management.md +219 -257
- package/assets/docs/guide/create-composition/layout.md +513 -315
- package/assets/docs/guide/create-composition/lock-design.md +90 -109
- package/assets/docs/guide/create-composition/multi-page.md +133 -113
- package/assets/docs/guide/create-composition/overview.md +16 -4
- package/assets/docs/guide/create-composition/programmatic.md +288 -344
- package/assets/docs/guide/create-composition.md +10 -5
- package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +443 -569
- package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +567 -470
- package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +179 -516
- package/assets/docs/guide/create-templates/add-dynamic-content.md +226 -224
- package/assets/docs/guide/create-templates/add-to-template-library.md +183 -193
- package/assets/docs/guide/create-templates/edit-or-remove.md +297 -303
- package/assets/docs/guide/create-templates/from-scratch.md +207 -268
- package/assets/docs/guide/create-templates/import/from-scene-file.md +158 -236
- package/assets/docs/guide/create-templates/import.md +145 -161
- package/assets/docs/guide/create-templates/lock.md +42 -295
- package/assets/docs/guide/create-templates/overview.md +33 -4
- package/assets/docs/guide/create-templates.md +9 -5
- package/assets/docs/guide/create-video/audio/adjust-speed.md +157 -207
- package/assets/docs/guide/create-video/audio/adjust-volume.md +116 -227
- package/assets/docs/guide/create-video/control.md +352 -193
- package/assets/docs/guide/create-video/limitations.md +175 -280
- package/assets/docs/guide/create-video.md +11 -10
- package/assets/docs/guide/edit-image/add-watermark.md +283 -330
- package/assets/docs/guide/edit-image/overview.md +29 -4
- package/assets/docs/guide/edit-image/remove-bg.md +283 -337
- package/assets/docs/guide/edit-image/replace-colors.md +424 -502
- package/assets/docs/guide/edit-image/transform/crop.md +463 -402
- package/assets/docs/guide/edit-image/transform/flip.md +353 -0
- package/assets/docs/guide/edit-image/transform/move.md +143 -100
- package/assets/docs/guide/edit-image/transform/resize.md +118 -88
- package/assets/docs/guide/edit-image/transform/rotate.md +132 -165
- package/assets/docs/guide/edit-image/transform/scale.md +230 -228
- package/assets/docs/guide/edit-image/transform.md +10 -5
- package/assets/docs/guide/edit-image.md +11 -7
- package/assets/docs/guide/edit-video/add-captions.md +344 -421
- package/assets/docs/guide/edit-video/add-watermark.md +312 -258
- package/assets/docs/guide/edit-video/join-and-arrange.md +237 -371
- package/assets/docs/guide/edit-video/redaction.md +419 -385
- package/assets/docs/guide/edit-video/split.md +243 -493
- package/assets/docs/guide/edit-video/transform/crop.md +21 -352
- package/assets/docs/guide/edit-video/transform/flip.md +102 -76
- package/assets/docs/guide/edit-video/transform/move.md +258 -310
- package/assets/docs/guide/edit-video/transform/resize.md +264 -428
- package/assets/docs/guide/edit-video/transform/rotate.md +265 -228
- package/assets/docs/guide/edit-video/transform/scale.md +320 -417
- package/assets/docs/guide/edit-video/transform.md +10 -6
- package/assets/docs/guide/edit-video/trim.md +448 -494
- package/assets/docs/guide/engine-interface.md +51 -62
- package/assets/docs/guide/export-save-publish/create-thumbnail.md +148 -184
- package/assets/docs/guide/export-save-publish/export/compress.md +161 -559
- package/assets/docs/guide/export-save-publish/export/overview.md +224 -373
- package/assets/docs/guide/export-save-publish/export/partial-export.md +386 -577
- package/assets/docs/guide/export-save-publish/export/size-limits.md +215 -310
- package/assets/docs/guide/export-save-publish/export/to-jpeg.md +132 -213
- package/assets/docs/guide/export-save-publish/export/to-pdf.md +139 -267
- package/assets/docs/guide/export-save-publish/export/to-png.md +121 -165
- package/assets/docs/guide/export-save-publish/export/to-raw-data.md +187 -234
- package/assets/docs/guide/export-save-publish/export/to-webp.md +160 -190
- package/assets/docs/guide/export-save-publish/export/with-color-mask.md +359 -203
- package/assets/docs/guide/export-save-publish/export.md +14 -11
- package/assets/docs/guide/export-save-publish/for-printing.md +141 -237
- package/assets/docs/guide/export-save-publish/for-social-media.md +124 -261
- package/assets/docs/guide/export-save-publish/pre-export-validation.md +436 -522
- package/assets/docs/guide/export-save-publish/save.md +167 -226
- package/assets/docs/guide/export-save-publish/store-custom-metadata.md +97 -162
- package/assets/docs/guide/file-format-support.md +9 -9
- package/assets/docs/guide/fills/color.md +370 -347
- package/assets/docs/guide/fills/image.md +167 -196
- package/assets/docs/guide/fills/overview.md +6 -4
- package/assets/docs/guide/fills/video.md +286 -438
- package/assets/docs/guide/fills.md +12 -8
- package/assets/docs/guide/filters-and-effects/apply.md +598 -664
- package/assets/docs/guide/filters-and-effects/blur.md +261 -159
- package/assets/docs/guide/filters-and-effects/chroma-key-green-screen.md +194 -293
- package/assets/docs/guide/filters-and-effects/create-custom-filters.md +548 -466
- package/assets/docs/guide/filters-and-effects/create-custom-lut-filter.md +176 -244
- package/assets/docs/guide/filters-and-effects/distortion.md +317 -384
- package/assets/docs/guide/filters-and-effects/duotone.md +221 -217
- package/assets/docs/guide/filters-and-effects/gradients.md +670 -813
- package/assets/docs/guide/filters-and-effects/overview.md +7 -7
- package/assets/docs/guide/filters-and-effects/support.md +97 -132
- package/assets/docs/guide/filters-and-effects.md +11 -6
- package/assets/docs/guide/get-started/agent-skills.md +20 -18
- package/assets/docs/guide/get-started/build-with-ai.md +7 -4
- package/assets/docs/guide/get-started/bun.md +219 -0
- package/assets/docs/guide/get-started/deno.md +161 -0
- package/assets/docs/guide/get-started/mcp-server.md +6 -4
- package/assets/docs/guide/get-started/overview.md +11 -6
- package/assets/docs/guide/get-started/vanilla-aws-lambda.md +506 -0
- package/assets/docs/guide/get-started/vanilla-clone-github-project.md +124 -0
- package/assets/docs/guide/get-started/vanilla.md +235 -0
- package/assets/docs/guide/guides/export-save-publish/export/audio.md +80 -66
- package/assets/docs/guide/guides.md +10 -9
- package/assets/docs/guide/import-media/asset-panel/refresh-assets.md +259 -288
- package/assets/docs/guide/import-media/concepts.md +20 -38
- package/assets/docs/guide/import-media/content-json-schema.md +145 -125
- package/assets/docs/guide/import-media/default-assets.md +113 -161
- package/assets/docs/guide/import-media/edit-or-remove-assets.md +391 -395
- package/assets/docs/guide/import-media/file-format-support.md +78 -61
- package/assets/docs/guide/import-media/from-remote-source/asset-versioning.md +273 -244
- package/assets/docs/guide/import-media/from-remote-source/remote-asset.md +152 -222
- package/assets/docs/guide/import-media/from-remote-source.md +9 -11
- package/assets/docs/guide/import-media/overview.md +5 -5
- package/assets/docs/guide/import-media/retrieve-mimetype.md +216 -108
- package/assets/docs/guide/import-media/size-limits.md +6 -4
- package/assets/docs/guide/import-media/source-sets.md +190 -251
- package/assets/docs/guide/import-media.md +10 -8
- package/assets/docs/guide/insert-media/audio.md +202 -195
- package/assets/docs/guide/insert-media/images.md +190 -188
- package/assets/docs/guide/insert-media/position-and-align.md +284 -551
- package/assets/docs/guide/insert-media/shapes-or-stickers.md +402 -418
- package/assets/docs/guide/insert-media/videos.md +236 -203
- package/assets/docs/guide/insert-media.md +10 -5
- package/assets/docs/guide/key-capabilities.md +36 -4
- package/assets/docs/guide/key-concepts.md +6 -4
- package/assets/docs/guide/licensing.md +6 -4
- package/assets/docs/guide/llms-txt.md +11 -7
- package/assets/docs/guide/open-the-editor/blank-canvas.md +102 -63
- package/assets/docs/guide/open-the-editor/from-image.md +157 -127
- package/assets/docs/guide/open-the-editor/from-template.md +131 -92
- package/assets/docs/guide/open-the-editor/from-video.md +204 -212
- package/assets/docs/guide/open-the-editor/import-design/from-archive.md +310 -360
- package/assets/docs/guide/open-the-editor/import-design/from-indesign.md +716 -513
- package/assets/docs/guide/open-the-editor/import-design/from-photoshop.md +667 -695
- package/assets/docs/guide/open-the-editor/import-design.md +228 -266
- package/assets/docs/guide/open-the-editor/load-scene.md +72 -68
- package/assets/docs/guide/open-the-editor/overview.md +6 -4
- package/assets/docs/guide/open-the-editor/uri-resolver.md +160 -251
- package/assets/docs/guide/open-the-editor.md +11 -9
- package/assets/docs/guide/outlines/overview.md +12 -4
- package/assets/docs/guide/outlines/shadows-and-glows.md +105 -410
- package/assets/docs/guide/outlines/strokes.md +218 -166
- package/assets/docs/guide/outlines.md +9 -4
- package/assets/docs/guide/overview.md +14 -6
- package/assets/docs/guide/performance.md +220 -113
- package/assets/docs/guide/plugins/print-ready-pdf.md +273 -368
- package/assets/docs/guide/plugins.md +10 -16
- package/assets/docs/guide/rules/asset-handling.md +7 -18
- package/assets/docs/guide/rules/common-pitfalls.md +25 -42
- package/assets/docs/guide/rules/content-fill-mode.md +4 -4
- package/assets/docs/guide/rules/enforce-brand-guidelines.md +398 -567
- package/assets/docs/guide/rules/lock-content.md +188 -231
- package/assets/docs/guide/rules/moderate-content.md +580 -571
- package/assets/docs/guide/rules/overview.md +345 -380
- package/assets/docs/guide/rules/silent-init-errors.md +4 -1
- package/assets/docs/guide/rules/verify-properties-before-use.md +2 -11
- package/assets/docs/guide/rules.md +10 -5
- package/assets/docs/guide/security.md +7 -5
- package/assets/docs/guide/serve-assets.md +57 -284
- package/assets/docs/guide/settings.md +96 -74
- package/assets/docs/guide/shapes.md +10 -5
- package/assets/docs/guide/stickers-and-shapes/combine.md +397 -583
- package/assets/docs/guide/stickers-and-shapes/create-cutout.md +181 -268
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-shapes.md +418 -431
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-stickers.md +147 -226
- package/assets/docs/guide/stickers-and-shapes/create-edit/edit-shapes.md +138 -123
- package/assets/docs/guide/stickers-and-shapes/insert-qr-code.md +151 -149
- package/assets/docs/guide/stickers.md +9 -4
- package/assets/docs/guide/text/add.md +470 -482
- package/assets/docs/guide/text/adjust-spacing.md +179 -214
- package/assets/docs/guide/text/auto-size.md +210 -271
- package/assets/docs/guide/text/edit.md +294 -309
- package/assets/docs/guide/text/effects.md +154 -190
- package/assets/docs/guide/text/emojis.md +199 -232
- package/assets/docs/guide/text/language-support.md +369 -382
- package/assets/docs/guide/text/overview.md +41 -4
- package/assets/docs/guide/text/styling.md +239 -273
- package/assets/docs/guide/text/text-designs.md +405 -544
- package/assets/docs/guide/text.md +10 -9
- package/assets/docs/guide/to-v1-19.md +12 -10
- package/assets/docs/guide/upgrade.md +8 -9
- package/assets/docs/guide/use-templates/apply-template.md +174 -163
- package/assets/docs/guide/use-templates/generate.md +171 -152
- package/assets/docs/guide/use-templates/overview.md +32 -4
- package/assets/docs/guide/use-templates/programmatic.md +266 -301
- package/assets/docs/guide/use-templates/replace-content.md +181 -171
- package/assets/docs/guide/what-is-cesdk.md +71 -282
- package/assets/docs/handbook/SKILL.md +24 -0
- package/dist/assets/inline.generated.d.ts.map +1 -1
- package/dist/assets/inline.generated.js +544 -406
- package/dist/assets/inline.generated.js.map +1 -1
- package/dist/assets/load-browser.d.ts +1 -1
- package/dist/assets/load-browser.js +1 -1
- package/dist/assets/load-browser.js.map +1 -1
- package/dist/assets/load-node.d.ts +1 -1
- package/dist/assets/load-node.js +1 -1
- package/dist/assets/load-node.js.map +1 -1
- package/dist/cli/http.d.ts.map +1 -1
- package/dist/cli/http.js +4 -28
- package/dist/cli/http.js.map +1 -1
- package/dist/cli/redirect-console.d.ts +1 -1
- package/dist/cli/redirect-console.d.ts.map +1 -1
- package/dist/cli/redirect-console.js +12 -3
- package/dist/cli/redirect-console.js.map +1 -1
- package/dist/cli/resolve-license.d.ts.map +1 -1
- package/dist/cli/resolve-license.js +8 -6
- package/dist/cli/resolve-license.js.map +1 -1
- package/dist/cli/stdio.d.ts +9 -0
- package/dist/cli/stdio.d.ts.map +1 -1
- package/dist/cli/stdio.js +48 -4
- package/dist/cli/stdio.js.map +1 -1
- package/dist/cli.js +10 -1
- package/dist/cli.js.map +1 -1
- package/dist/config.d.ts +11 -2
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +20 -1
- package/dist/config.js.map +1 -1
- package/dist/diagnostics/bundle.d.ts +10 -0
- package/dist/diagnostics/bundle.d.ts.map +1 -0
- package/dist/diagnostics/bundle.js +148 -0
- package/dist/diagnostics/bundle.js.map +1 -0
- package/dist/diagnostics/compose.d.ts +3 -0
- package/dist/diagnostics/compose.d.ts.map +1 -0
- package/dist/diagnostics/compose.js +15 -0
- package/dist/diagnostics/compose.js.map +1 -0
- package/dist/diagnostics/events.d.ts +34 -0
- package/dist/diagnostics/events.d.ts.map +1 -0
- package/dist/diagnostics/events.js +3 -0
- package/dist/diagnostics/events.js.map +1 -0
- package/dist/diagnostics/file-sink.d.ts +38 -0
- package/dist/diagnostics/file-sink.d.ts.map +1 -0
- package/dist/diagnostics/file-sink.js +157 -0
- package/dist/diagnostics/file-sink.js.map +1 -0
- package/dist/diagnostics/redact.d.ts +7 -0
- package/dist/diagnostics/redact.d.ts.map +1 -0
- package/dist/diagnostics/redact.js +43 -0
- package/dist/diagnostics/redact.js.map +1 -0
- package/dist/diagnostics/tool-call-adapter.d.ts +4 -0
- package/dist/diagnostics/tool-call-adapter.d.ts.map +1 -0
- package/dist/diagnostics/tool-call-adapter.js +21 -0
- package/dist/diagnostics/tool-call-adapter.js.map +1 -0
- package/dist/engine/cesdk-adapter.d.ts +5 -1
- package/dist/engine/cesdk-adapter.d.ts.map +1 -1
- package/dist/engine/cesdk-adapter.js +9 -2
- package/dist/engine/cesdk-adapter.js.map +1 -1
- package/dist/engine/index.d.ts +1 -0
- package/dist/engine/index.d.ts.map +1 -1
- package/dist/engine/index.js +4 -0
- package/dist/engine/index.js.map +1 -1
- package/dist/engine/scene-resource-schemes.d.ts +2 -0
- package/dist/engine/scene-resource-schemes.d.ts.map +1 -0
- package/dist/engine/scene-resource-schemes.js +20 -0
- package/dist/engine/scene-resource-schemes.js.map +1 -0
- package/dist/http/server.d.ts +0 -6
- package/dist/http/server.d.ts.map +1 -1
- package/dist/http/server.js +1 -2
- package/dist/http/server.js.map +1 -1
- package/dist/server.d.ts +0 -4
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +4 -60
- package/dist/server.js.map +1 -1
- package/dist/test/scripts/changelog-add.d.ts +8 -0
- package/dist/test/scripts/changelog-add.d.ts.map +1 -0
- package/dist/test/scripts/changelog-add.js +50 -0
- package/dist/test/scripts/changelog-add.js.map +1 -0
- package/dist/test/scripts/changelog-collate.d.ts +38 -0
- package/dist/test/scripts/changelog-collate.d.ts.map +1 -0
- package/dist/test/scripts/changelog-collate.js +171 -0
- package/dist/test/scripts/changelog-collate.js.map +1 -0
- package/dist/test/test/changelog.test.d.ts +2 -0
- package/dist/test/test/changelog.test.d.ts.map +1 -0
- package/dist/test/test/changelog.test.js +293 -0
- package/dist/test/test/changelog.test.js.map +1 -0
- package/dist/test/test/cli/dispatcher.test.js +10 -3
- package/dist/test/test/cli/dispatcher.test.js.map +1 -1
- package/dist/test/test/cli/redirect-console.test.js +31 -0
- package/dist/test/test/cli/redirect-console.test.js.map +1 -1
- package/dist/test/test/cli/resolve-license.test.js +10 -1
- package/dist/test/test/cli/resolve-license.test.js.map +1 -1
- package/dist/test/test/cli/stdio-diagnostics.test.d.ts +2 -0
- package/dist/test/test/cli/stdio-diagnostics.test.d.ts.map +1 -0
- package/dist/test/test/cli/stdio-diagnostics.test.js +31 -0
- package/dist/test/test/cli/stdio-diagnostics.test.js.map +1 -0
- package/dist/test/test/config.test.js +17 -13
- package/dist/test/test/config.test.js.map +1 -1
- package/dist/test/test/diagnostics/bundle.test.d.ts +2 -0
- package/dist/test/test/diagnostics/bundle.test.d.ts.map +1 -0
- package/dist/test/test/diagnostics/bundle.test.js +53 -0
- package/dist/test/test/diagnostics/bundle.test.js.map +1 -0
- package/dist/test/test/diagnostics/compose.test.d.ts +2 -0
- package/dist/test/test/diagnostics/compose.test.d.ts.map +1 -0
- package/dist/test/test/diagnostics/compose.test.js +31 -0
- package/dist/test/test/diagnostics/compose.test.js.map +1 -0
- package/dist/test/test/diagnostics/file-sink.test.d.ts +2 -0
- package/dist/test/test/diagnostics/file-sink.test.d.ts.map +1 -0
- package/dist/test/test/diagnostics/file-sink.test.js +113 -0
- package/dist/test/test/diagnostics/file-sink.test.js.map +1 -0
- package/dist/test/test/diagnostics/redact.test.d.ts +2 -0
- package/dist/test/test/diagnostics/redact.test.d.ts.map +1 -0
- package/dist/test/test/diagnostics/redact.test.js +59 -0
- package/dist/test/test/diagnostics/redact.test.js.map +1 -0
- package/dist/test/test/diagnostics/tool-call-adapter.test.d.ts +2 -0
- package/dist/test/test/diagnostics/tool-call-adapter.test.d.ts.map +1 -0
- package/dist/test/test/diagnostics/tool-call-adapter.test.js +34 -0
- package/dist/test/test/diagnostics/tool-call-adapter.test.js.map +1 -0
- package/dist/test/test/engine/cesdk-adapter.test.d.ts +2 -0
- package/dist/test/test/engine/cesdk-adapter.test.d.ts.map +1 -0
- package/dist/test/test/engine/cesdk-adapter.test.js +32 -0
- package/dist/test/test/engine/cesdk-adapter.test.js.map +1 -0
- package/dist/test/test/handbook-contract.test.js +6 -2
- package/dist/test/test/handbook-contract.test.js.map +1 -1
- package/dist/test/test/http/server.test.js +0 -36
- package/dist/test/test/http/server.test.js.map +1 -1
- package/dist/test/test/http/workspace-auth.test.js +0 -1
- package/dist/test/test/http/workspace-auth.test.js.map +1 -1
- package/dist/test/test/server.test.js +0 -40
- package/dist/test/test/server.test.js.map +1 -1
- package/dist/test/test/tools/edit-harness.d.ts +14 -0
- package/dist/test/test/tools/edit-harness.d.ts.map +1 -0
- package/dist/test/test/tools/edit-harness.js +30 -0
- package/dist/test/test/tools/edit-harness.js.map +1 -0
- package/dist/test/test/tools/edit.telemetry.test.d.ts +2 -0
- package/dist/test/test/tools/edit.telemetry.test.d.ts.map +1 -0
- package/dist/test/test/tools/edit.telemetry.test.js +46 -0
- package/dist/test/test/tools/edit.telemetry.test.js.map +1 -0
- package/dist/test/test/tools/export-harness.d.ts +13 -0
- package/dist/test/test/tools/export-harness.d.ts.map +1 -0
- package/dist/test/test/tools/export-harness.js +27 -0
- package/dist/test/test/tools/export-harness.js.map +1 -0
- package/dist/test/test/tools/export.telemetry.test.d.ts +2 -0
- package/dist/test/test/tools/export.telemetry.test.d.ts.map +1 -0
- package/dist/test/test/tools/export.telemetry.test.js +65 -0
- package/dist/test/test/tools/export.telemetry.test.js.map +1 -0
- package/dist/test/test/tools/import.test.d.ts +2 -0
- package/dist/test/test/tools/import.test.d.ts.map +1 -0
- package/dist/test/test/tools/import.test.js +122 -0
- package/dist/test/test/tools/import.test.js.map +1 -0
- package/dist/test/test/tools/index.test.js +78 -16
- package/dist/test/test/tools/index.test.js.map +1 -1
- package/dist/test/test/tools/load.integration.test.d.ts +2 -0
- package/dist/test/test/tools/load.integration.test.d.ts.map +1 -0
- package/dist/test/test/tools/load.integration.test.js +165 -0
- package/dist/test/test/tools/load.integration.test.js.map +1 -0
- package/dist/test/test/tools/load.test.d.ts +2 -0
- package/dist/test/test/tools/load.test.d.ts.map +1 -0
- package/dist/test/test/tools/load.test.js +387 -0
- package/dist/test/test/tools/load.test.js.map +1 -0
- package/dist/test/test/tools/preview-harness.d.ts +9 -0
- package/dist/test/test/tools/preview-harness.d.ts.map +1 -0
- package/dist/test/test/tools/preview-harness.js +23 -0
- package/dist/test/test/tools/preview-harness.js.map +1 -0
- package/dist/test/test/tools/preview.telemetry.test.d.ts +2 -0
- package/dist/test/test/tools/preview.telemetry.test.d.ts.map +1 -0
- package/dist/test/test/tools/preview.telemetry.test.js +36 -0
- package/dist/test/test/tools/preview.telemetry.test.js.map +1 -0
- package/dist/test/test/tools/schema-best-practices.d.ts +13 -0
- package/dist/test/test/tools/schema-best-practices.d.ts.map +1 -0
- package/dist/test/test/tools/schema-best-practices.js +169 -0
- package/dist/test/test/tools/schema-best-practices.js.map +1 -0
- package/dist/test/test/tools/schema-best-practices.test.d.ts +3 -0
- package/dist/test/test/tools/schema-best-practices.test.d.ts.map +1 -0
- package/dist/test/test/tools/schema-best-practices.test.js +194 -0
- package/dist/test/test/tools/schema-best-practices.test.js.map +1 -0
- package/dist/test/test/tools/spans.test.d.ts +2 -0
- package/dist/test/test/tools/spans.test.d.ts.map +1 -0
- package/dist/test/test/tools/spans.test.js +84 -0
- package/dist/test/test/tools/spans.test.js.map +1 -0
- package/dist/test/test/viewer/cesdk-cdn.test.d.ts +2 -0
- package/dist/test/test/viewer/cesdk-cdn.test.d.ts.map +1 -0
- package/dist/test/test/viewer/cesdk-cdn.test.js +19 -0
- package/dist/test/test/viewer/cesdk-cdn.test.js.map +1 -0
- package/dist/test/test/viewer/config-route.test.d.ts +2 -0
- package/dist/test/test/viewer/config-route.test.d.ts.map +1 -0
- package/dist/test/test/viewer/config-route.test.js +28 -0
- package/dist/test/test/viewer/config-route.test.js.map +1 -0
- package/dist/test/test/viewer/spa-version.test.d.ts +2 -0
- package/dist/test/test/viewer/spa-version.test.d.ts.map +1 -0
- package/dist/test/test/viewer/spa-version.test.js +14 -0
- package/dist/test/test/viewer/spa-version.test.js.map +1 -0
- package/dist/test/test/workspace/content-hash.test.d.ts +2 -0
- package/dist/test/test/workspace/content-hash.test.d.ts.map +1 -0
- package/dist/test/test/workspace/content-hash.test.js +17 -0
- package/dist/test/test/workspace/content-hash.test.js.map +1 -0
- package/dist/test/tsconfig.test.tsbuildinfo +1 -1
- package/dist/test/vitest.config.js +1 -1
- package/dist/test/vitest.config.js.map +1 -1
- package/dist/tools/asset-generate.d.ts.map +1 -1
- package/dist/tools/asset-generate.js +1 -8
- package/dist/tools/asset-generate.js.map +1 -1
- package/dist/tools/edit.d.ts +3 -0
- package/dist/tools/edit.d.ts.map +1 -1
- package/dist/tools/edit.js +145 -96
- package/dist/tools/edit.js.map +1 -1
- package/dist/tools/export.d.ts +3 -0
- package/dist/tools/export.d.ts.map +1 -1
- package/dist/tools/export.js +146 -108
- package/dist/tools/export.js.map +1 -1
- package/dist/tools/import.d.ts +12 -0
- package/dist/tools/import.d.ts.map +1 -0
- package/dist/tools/import.js +144 -0
- package/dist/tools/import.js.map +1 -0
- package/dist/tools/index.d.ts +3 -0
- package/dist/tools/index.d.ts.map +1 -1
- package/dist/tools/index.js +44 -4
- package/dist/tools/index.js.map +1 -1
- package/dist/tools/load.d.ts +26 -0
- package/dist/tools/load.d.ts.map +1 -0
- package/dist/tools/load.js +400 -0
- package/dist/tools/load.js.map +1 -0
- package/dist/tools/preview.d.ts +3 -0
- package/dist/tools/preview.d.ts.map +1 -1
- package/dist/tools/preview.js +79 -44
- package/dist/tools/preview.js.map +1 -1
- package/dist/tools/result.d.ts +1 -1
- package/dist/tools/result.js +2 -2
- package/dist/tools/result.js.map +1 -1
- package/dist/tools/spans.d.ts +45 -0
- package/dist/tools/spans.d.ts.map +1 -0
- package/dist/tools/spans.js +77 -0
- package/dist/tools/spans.js.map +1 -0
- package/dist/tools/telemetry-wrapper.d.ts +4 -0
- package/dist/tools/telemetry-wrapper.d.ts.map +1 -0
- package/dist/tools/telemetry-wrapper.js +43 -0
- package/dist/tools/telemetry-wrapper.js.map +1 -0
- package/dist/viewer/cesdk-cdn.d.ts +16 -0
- package/dist/viewer/cesdk-cdn.d.ts.map +1 -0
- package/dist/viewer/cesdk-cdn.js +30 -0
- package/dist/viewer/cesdk-cdn.js.map +1 -0
- package/dist/viewer/router.d.ts +6 -0
- package/dist/viewer/router.d.ts.map +1 -1
- package/dist/viewer/router.js +4 -1
- package/dist/viewer/router.js.map +1 -1
- package/dist/viewer/spa-assets.generated.d.ts.map +1 -1
- package/dist/viewer/spa-assets.generated.js +2 -3
- package/dist/viewer/spa-assets.generated.js.map +1 -1
- package/dist/workspace/content-hash.d.ts +2 -0
- package/dist/workspace/content-hash.d.ts.map +1 -0
- package/dist/workspace/content-hash.js +15 -0
- package/dist/workspace/content-hash.js.map +1 -0
- package/package.json +18 -9
- package/assets/docs/guide/actions.md +0 -1038
- package/assets/docs/guide/animation/overview.md +0 -22
- package/assets/docs/guide/automation/batch-processing.md +0 -474
- package/assets/docs/guide/browser-support.md +0 -38
- package/assets/docs/guide/concepts/edit-modes.md +0 -431
- package/assets/docs/guide/concepts/headless-mode/browser.md +0 -291
- package/assets/docs/guide/create-audio/audio.md +0 -336
- package/assets/docs/guide/create-video/overview.md +0 -224
- package/assets/docs/guide/create-video/timeline-editor.md +0 -622
- package/assets/docs/guide/create-video/update-caption-presets.md +0 -676
- package/assets/docs/guide/edit-image/vectorize.md +0 -204
- package/assets/docs/guide/export-save-publish/export/to-html5.md +0 -474
- package/assets/docs/guide/export-save-publish/export/to-mp4.md +0 -364
- package/assets/docs/guide/get-started/vanilla-js/quickstart.md +0 -175
- package/assets/docs/guide/grid-and-rulers.md +0 -222
- package/assets/docs/guide/guides/text/rendering-internals.md +0 -796
- package/assets/docs/guide/import-media/asset-library.md +0 -23
- package/assets/docs/guide/import-media/asset-panel/basics.md +0 -324
- package/assets/docs/guide/import-media/asset-panel/customize.md +0 -478
- package/assets/docs/guide/import-media/asset-panel/thumbnails.md +0 -633
- package/assets/docs/guide/import-media/capture-from-camera/record-video.md +0 -137
- package/assets/docs/guide/import-media/capture-from-camera.md +0 -20
- package/assets/docs/guide/import-media/from-local-source/user-upload.md +0 -438
- package/assets/docs/guide/import-media/from-local-source.md +0 -20
- package/assets/docs/guide/import-media/from-remote-source/getty-images.md +0 -627
- package/assets/docs/guide/import-media/from-remote-source/imgly-premium-assets.md +0 -625
- package/assets/docs/guide/import-media/from-remote-source/pexels.md +0 -692
- package/assets/docs/guide/import-media/from-remote-source/soundstripe.md +0 -497
- package/assets/docs/guide/import-media/from-remote-source/third-party.md +0 -51
- package/assets/docs/guide/import-media/from-remote-source/unsplash.md +0 -914
- package/assets/docs/guide/import-media/from-remote-source/your-server.md +0 -764
- package/assets/docs/guide/open-the-editor/from-htmlcanvas.md +0 -228
- package/assets/docs/guide/open-the-editor/set-zoom-level.md +0 -303
- package/assets/docs/guide/plugins/asset-sources.md +0 -553
- package/assets/docs/guide/starterkits/3d-mockup-editor.md +0 -748
- package/assets/docs/guide/starterkits/advanced-editor.md +0 -698
- package/assets/docs/guide/starterkits/advanced-video-editor.md +0 -696
- package/assets/docs/guide/starterkits/ai-editor.md +0 -749
- package/assets/docs/guide/starterkits/airtable-image-editor.md +0 -672
- package/assets/docs/guide/starterkits/apparel-ui.md +0 -188
- package/assets/docs/guide/starterkits/assets.md +0 -27
- package/assets/docs/guide/starterkits/auto-resize.md +0 -586
- package/assets/docs/guide/starterkits/automated-video-generation.md +0 -692
- package/assets/docs/guide/starterkits/background-removal-editor.md +0 -480
- package/assets/docs/guide/starterkits/content-moderation.md +0 -863
- package/assets/docs/guide/starterkits/creative-automation.md +0 -28
- package/assets/docs/guide/starterkits/custom-built-uis.md +0 -26
- package/assets/docs/guide/starterkits/customization.md +0 -29
- package/assets/docs/guide/starterkits/cutout-lines-editor.md +0 -470
- package/assets/docs/guide/starterkits/data-merge.md +0 -850
- package/assets/docs/guide/starterkits/design-editor.md +0 -698
- package/assets/docs/guide/starterkits/design-generation.md +0 -719
- package/assets/docs/guide/starterkits/design-validation.md +0 -808
- package/assets/docs/guide/starterkits/editor-ui-configurations.md +0 -14
- package/assets/docs/guide/starterkits/export-options.md +0 -724
- package/assets/docs/guide/starterkits/export-using-renderer.md +0 -708
- package/assets/docs/guide/starterkits/extensibility.md +0 -28
- package/assets/docs/guide/starterkits/force-crop-editor.md +0 -675
- package/assets/docs/guide/starterkits/form-based-template-adoption.md +0 -522
- package/assets/docs/guide/starterkits/getty-images-editor.md +0 -700
- package/assets/docs/guide/starterkits/html5-ads-exporter.md +0 -719
- package/assets/docs/guide/starterkits/indesign-template-import.md +0 -580
- package/assets/docs/guide/starterkits/layouts-editor.md +0 -724
- package/assets/docs/guide/starterkits/mobile-ui.md +0 -185
- package/assets/docs/guide/starterkits/mockup-editor.md +0 -745
- package/assets/docs/guide/starterkits/multi-image-generation.md +0 -542
- package/assets/docs/guide/starterkits/page-sizes-editor.md +0 -657
- package/assets/docs/guide/starterkits/pexels-image-editor.md +0 -665
- package/assets/docs/guide/starterkits/photo-editor.md +0 -755
- package/assets/docs/guide/starterkits/photo-ui.md +0 -186
- package/assets/docs/guide/starterkits/photobook-ui.md +0 -188
- package/assets/docs/guide/starterkits/placeholders.md +0 -678
- package/assets/docs/guide/starterkits/player.md +0 -405
- package/assets/docs/guide/starterkits/plugins.md +0 -25
- package/assets/docs/guide/starterkits/postcard-editor.md +0 -202
- package/assets/docs/guide/starterkits/pptx-template-import.md +0 -581
- package/assets/docs/guide/starterkits/print-ready-pdf-editor.md +0 -746
- package/assets/docs/guide/starterkits/product-editor.md +0 -773
- package/assets/docs/guide/starterkits/psd-template-import.md +0 -580
- package/assets/docs/guide/starterkits/qr-code-editor.md +0 -470
- package/assets/docs/guide/starterkits/single-page-editor.md +0 -661
- package/assets/docs/guide/starterkits/start-with-image.md +0 -684
- package/assets/docs/guide/starterkits/start-with-video.md +0 -651
- package/assets/docs/guide/starterkits/t-shirt-designer.md +0 -742
- package/assets/docs/guide/starterkits/templating.md +0 -23
- package/assets/docs/guide/starterkits/theming.md +0 -662
- package/assets/docs/guide/starterkits/translation-internationalization.md +0 -662
- package/assets/docs/guide/starterkits/unsplash-editor.md +0 -839
- package/assets/docs/guide/starterkits/vectorizer-editor.md +0 -466
- package/assets/docs/guide/starterkits/version-history.md +0 -745
- package/assets/docs/guide/starterkits/video-animations.md +0 -853
- package/assets/docs/guide/starterkits/video-captions.md +0 -884
- package/assets/docs/guide/starterkits/video-editing.md +0 -25
- package/assets/docs/guide/starterkits/video-editor.md +0 -696
- package/assets/docs/guide/starterkits/video-export-options.md +0 -676
- package/assets/docs/guide/starterkits/viewer.md +0 -400
- package/assets/docs/guide/starterkits.md +0 -41
- package/assets/docs/guide/stickers-and-shapes/create-edit/vector-edit.md +0 -362
- package/assets/docs/guide/text/custom-fonts.md +0 -401
- package/assets/docs/guide/text/decorations.md +0 -330
- package/assets/docs/guide/text/enumerations.md +0 -258
- package/assets/docs/guide/to-v1-10.md +0 -131
- package/assets/docs/guide/to-v1-13.md +0 -165
- package/assets/docs/guide/to-v1-32.md +0 -110
- package/assets/docs/guide/to-v1-69.md +0 -468
- package/assets/docs/guide/to-v1-72.md +0 -193
- package/assets/docs/guide/use-templates/library.md +0 -450
- package/assets/docs/guide/user-interface/ai-integration/audio-generation.md +0 -428
- package/assets/docs/guide/user-interface/ai-integration/auto-captions.md +0 -337
- package/assets/docs/guide/user-interface/ai-integration/custom-provider.md +0 -853
- package/assets/docs/guide/user-interface/ai-integration/gateway-provider.md +0 -1045
- package/assets/docs/guide/user-interface/ai-integration/image-generation.md +0 -641
- package/assets/docs/guide/user-interface/ai-integration/integrate.md +0 -966
- package/assets/docs/guide/user-interface/ai-integration/proxy-server.md +0 -99
- package/assets/docs/guide/user-interface/ai-integration/text-generation.md +0 -498
- package/assets/docs/guide/user-interface/ai-integration/video-generation.md +0 -493
- package/assets/docs/guide/user-interface/ai-integration.md +0 -30
- package/assets/docs/guide/user-interface/appearance/change-ui-font.md +0 -316
- package/assets/docs/guide/user-interface/appearance/custom-labels.md +0 -509
- package/assets/docs/guide/user-interface/appearance/icons.md +0 -373
- package/assets/docs/guide/user-interface/appearance/theming.md +0 -665
- package/assets/docs/guide/user-interface/appearance.md +0 -23
- package/assets/docs/guide/user-interface/build-your-own-ui.md +0 -620
- package/assets/docs/guide/user-interface/customization/canvas-menu.md +0 -412
- package/assets/docs/guide/user-interface/customization/canvas.md +0 -281
- package/assets/docs/guide/user-interface/customization/color-palette.md +0 -413
- package/assets/docs/guide/user-interface/customization/crop-presets.md +0 -384
- package/assets/docs/guide/user-interface/customization/disable-or-enable.md +0 -676
- package/assets/docs/guide/user-interface/customization/dock.md +0 -399
- package/assets/docs/guide/user-interface/customization/force-crop.md +0 -289
- package/assets/docs/guide/user-interface/customization/inspector-bar.md +0 -371
- package/assets/docs/guide/user-interface/customization/navigation-bar.md +0 -516
- package/assets/docs/guide/user-interface/customization/page-format.md +0 -436
- package/assets/docs/guide/user-interface/customization/panel.md +0 -605
- package/assets/docs/guide/user-interface/customization/quick-start/add-action-buttons.md +0 -531
- package/assets/docs/guide/user-interface/customization/quick-start/add-dock-buttons.md +0 -358
- package/assets/docs/guide/user-interface/customization/quick-start/create-custom-components.md +0 -374
- package/assets/docs/guide/user-interface/customization/quick-start/reorder-components.md +0 -323
- package/assets/docs/guide/user-interface/customization/quick-start/show-hide-components.md +0 -294
- package/assets/docs/guide/user-interface/customization/quick-start.md +0 -12
- package/assets/docs/guide/user-interface/customization/reference/component-order-api.md +0 -519
- package/assets/docs/guide/user-interface/customization/reference/component-reference.md +0 -333
- package/assets/docs/guide/user-interface/customization/reference.md +0 -12
- package/assets/docs/guide/user-interface/customization.md +0 -39
- package/assets/docs/guide/user-interface/localization.md +0 -633
- package/assets/docs/guide/user-interface/overview.md +0 -167
- package/assets/docs/guide/user-interface/ui-extensions/add-custom-feature.md +0 -411
- package/assets/docs/guide/user-interface/ui-extensions/asset-library.md +0 -721
- package/assets/docs/guide/user-interface/ui-extensions/create-custom-panel.md +0 -331
- package/assets/docs/guide/user-interface/ui-extensions/customize-behaviour.md +0 -553
- package/assets/docs/guide/user-interface/ui-extensions/notifications-and-dialogs.md +0 -672
- package/assets/docs/guide/user-interface/ui-extensions/quick-actions.md +0 -415
- package/assets/docs/guide/user-interface/ui-extensions/register-new-component.md +0 -521
- package/assets/docs/guide/user-interface/ui-extensions.md +0 -26
- package/assets/docs/guide/user-interface.md +0 -25
- package/assets/prompts/evals-assetGenerate.md +0 -12
- package/assets/prompts/evals-brutalistCore.md +0 -34
- package/assets/prompts/evals-danskCatalogue.md +0 -31
- package/assets/prompts/evals-exportRoundTrip.md +0 -12
- package/assets/prompts/evals-inspectPriorCode.md +0 -16
- package/assets/prompts/evals-listProjectFiles.md +0 -6
- package/assets/prompts/evals-readAndExplainScript.md +0 -6
- package/assets/prompts/evals-resumeAcrossRestart.md +0 -15
- package/assets/prompts/evals-rewindRecovery.md +0 -10
- package/assets/prompts/evals-searchAcrossFiles.md +0 -6
- package/assets/prompts/evals-weddingCard.md +0 -20
- package/assets/prompts/explain.md +0 -6
- package/assets/prompts/review.md +0 -6
- package/dist/frontmatter.d.ts +0 -15
- package/dist/frontmatter.d.ts.map +0 -1
- package/dist/frontmatter.js +0 -46
- package/dist/frontmatter.js.map +0 -1
- package/dist/test/test/frontmatter.test.d.ts +0 -2
- package/dist/test/test/frontmatter.test.d.ts.map +0 -1
- package/dist/test/test/frontmatter.test.js +0 -55
- package/dist/test/test/frontmatter.test.js.map +0 -1
|
@@ -1,749 +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:** [Starter Kits](./starterkits.md) > [AI Editor](./starterkits/ai-editor.md)
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Quickly add AI-powered visual editing and media generation to your web app — seamlessly connect any AI model.
|
|
8
|
-
|
|
9
|
-

|
|
10
|
-
|
|
11
|
-
> **Reading time:** 15 minutes
|
|
12
|
-
>
|
|
13
|
-
> **Resources:**
|
|
14
|
-
>
|
|
15
|
-
> - [Download examples](https://github.com/imgly/starterkit-ai-editor-react-web/archive/refs/tags/release-$UBQ_VERSION$.zip)
|
|
16
|
-
> - [View source on GitHub](https://github.com/imgly/starterkit-ai-editor-react-web/tree/release-$UBQ_VERSION$)
|
|
17
|
-
> - [Open in StackBlitz](https://stackblitz.com/github/imgly/starterkit-ai-editor-react-web/tree/release-$UBQ_VERSION$)
|
|
18
|
-
> - [Live demo](https://img.ly/docs/cesdk/examples/starterkit-ai-editor/)
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Pre-requisites
|
|
23
|
-
|
|
24
|
-
This guide assumes basic familiarity with React and TypeScript.
|
|
25
|
-
|
|
26
|
-
- **Node.js v20+** with npm – [Download](https://nodejs.org/)
|
|
27
|
-
- **Supported browsers** – Chrome 114+, Edge 114+, Firefox 115+, Safari 15.6+<br />
|
|
28
|
-
See [Browser Support](./browser-support.md) for the full list
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
<Tabs syncKey="project-type">
|
|
33
|
-
<TabItem label="New Project">
|
|
34
|
-
## Get Started
|
|
35
|
-
|
|
36
|
-
Start fresh with a standalone AI Editor project. This creates a complete, ready-to-run React application with Design, Photo, and Video editing modes and AI generation capabilities.
|
|
37
|
-
|
|
38
|
-
## Step 1: Clone the Repository
|
|
39
|
-
|
|
40
|
-
<TerminalTabs>
|
|
41
|
-
<TerminalTab label="git">
|
|
42
|
-
git clone https://github.com/imgly/starterkit-ai-editor-react-web.git
|
|
43
|
-
</TerminalTab>
|
|
44
|
-
|
|
45
|
-
<TerminalTab label="degit">
|
|
46
|
-
npx degit imgly/starterkit-ai-editor-react-web starterkit-ai-editor-react-web
|
|
47
|
-
</TerminalTab>
|
|
48
|
-
</TerminalTabs>
|
|
49
|
-
|
|
50
|
-
The `src/` folder contains the editor code:
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
src/
|
|
54
|
-
├── app/ # Demo application
|
|
55
|
-
├── imgly/
|
|
56
|
-
│ ├── config/
|
|
57
|
-
│ │ ├── design-editor/
|
|
58
|
-
│ │ │ ├── actions.ts # Export/import actions
|
|
59
|
-
│ │ │ ├── features.ts # Feature toggles
|
|
60
|
-
│ │ │ ├── i18n.ts # Translations
|
|
61
|
-
│ │ │ ├── plugin.ts # Main configuration plugin
|
|
62
|
-
│ │ │ ├── settings.ts # Engine settings
|
|
63
|
-
│ │ │ └── ui/
|
|
64
|
-
│ │ │ ├── canvas.ts # Canvas configuration
|
|
65
|
-
│ │ │ ├── components.ts # Custom component registration
|
|
66
|
-
│ │ │ ├── dock.ts # Dock layout configuration
|
|
67
|
-
│ │ │ ├── index.ts # Combines UI customization exports
|
|
68
|
-
│ │ │ ├── inspectorBar.ts # Inspector bar layout
|
|
69
|
-
│ │ │ ├── navigationBar.ts # Navigation bar layout
|
|
70
|
-
│ │ │ └── panel.ts # Panel configuration
|
|
71
|
-
│ │ ├── photo-editor/ # Same structure as design-editor/
|
|
72
|
-
│ │ └── video-editor/ # Same structure as design-editor/
|
|
73
|
-
│ ├── index.ts # Editor initialization function
|
|
74
|
-
│ └── plugins/
|
|
75
|
-
│ └── ai-app/
|
|
76
|
-
│ ├── ai-apps.ts
|
|
77
|
-
│ └── ai-providers.ts
|
|
78
|
-
└── index.tsx # Application entry point
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Step 2: Install Dependencies
|
|
82
|
-
|
|
83
|
-
Install the required packages:
|
|
84
|
-
|
|
85
|
-
<TerminalTabs syncKey="package-manager">
|
|
86
|
-
<TerminalTab label="npm">
|
|
87
|
-
cd starterkit-ai-editor-react-web
|
|
88
|
-
npm install
|
|
89
|
-
</TerminalTab>
|
|
90
|
-
|
|
91
|
-
<TerminalTab label="pnpm">
|
|
92
|
-
cd starterkit-ai-editor-react-web
|
|
93
|
-
pnpm install
|
|
94
|
-
</TerminalTab>
|
|
95
|
-
|
|
96
|
-
<TerminalTab label="yarn">
|
|
97
|
-
cd starterkit-ai-editor-react-web
|
|
98
|
-
yarn
|
|
99
|
-
</TerminalTab>
|
|
100
|
-
</TerminalTabs>
|
|
101
|
-
|
|
102
|
-
## Step 3: Download Assets
|
|
103
|
-
|
|
104
|
-
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
105
|
-
|
|
106
|
-
<TerminalTabs>
|
|
107
|
-
<TerminalTab label="Download">
|
|
108
|
-
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
109
|
-
unzip imgly-assets.zip -d public/
|
|
110
|
-
rm imgly-assets.zip
|
|
111
|
-
</TerminalTab>
|
|
112
|
-
</TerminalTabs>
|
|
113
|
-
|
|
114
|
-
> **Asset Configuration:** The starter kit is pre-configured to load assets from `/assets`. If you place assets in a different location, update the `baseURL` in `src/index.tsx`.
|
|
115
|
-
|
|
116
|
-
```typescript title="src/index.tsx"
|
|
117
|
-
const config = {
|
|
118
|
-
// ...
|
|
119
|
-
baseURL: '/assets'
|
|
120
|
-
// ...
|
|
121
|
-
};
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
## Step 4: Run the Development Server
|
|
125
|
-
|
|
126
|
-
<TerminalTabs syncKey="package-manager">
|
|
127
|
-
<TerminalTab label="npm">
|
|
128
|
-
npm run dev
|
|
129
|
-
</TerminalTab>
|
|
130
|
-
|
|
131
|
-
<TerminalTab label="pnpm">
|
|
132
|
-
pnpm run dev
|
|
133
|
-
</TerminalTab>
|
|
134
|
-
|
|
135
|
-
<TerminalTab label="yarn">
|
|
136
|
-
yarn dev
|
|
137
|
-
</TerminalTab>
|
|
138
|
-
</TerminalTabs>
|
|
139
|
-
|
|
140
|
-
Open `http://localhost:5173` in your browser. Use the mode selector at the top to switch between Design, Photo, and Video modes.
|
|
141
|
-
|
|
142
|
-
</TabItem>
|
|
143
|
-
|
|
144
|
-
<TabItem label="Existing Project">
|
|
145
|
-
## Get Started
|
|
146
|
-
|
|
147
|
-
Integrate the AI Editor into an existing React application. This adds the editor configuration to your current project structure.
|
|
148
|
-
|
|
149
|
-
## Step 1: Clone
|
|
150
|
-
|
|
151
|
-
<TerminalTabs>
|
|
152
|
-
<TerminalTab label="Navigate">
|
|
153
|
-
cd your-project
|
|
154
|
-
</TerminalTab>
|
|
155
|
-
</TerminalTabs>
|
|
156
|
-
|
|
157
|
-
Clone the starter kit and copy the editor configuration to your project:
|
|
158
|
-
|
|
159
|
-
<TerminalTabs>
|
|
160
|
-
<TerminalTab label="git">
|
|
161
|
-
git clone https://github.com/imgly/starterkit-ai-editor-react-web.git
|
|
162
|
-
cp -r starterkit-ai-editor-react-web/src/imgly ./src/imgly
|
|
163
|
-
rm -rf starterkit-ai-editor-react-web
|
|
164
|
-
</TerminalTab>
|
|
165
|
-
|
|
166
|
-
<TerminalTab label="degit">
|
|
167
|
-
npx degit imgly/starterkit-ai-editor-react-web/src/imgly ./src/imgly
|
|
168
|
-
</TerminalTab>
|
|
169
|
-
</TerminalTabs>
|
|
170
|
-
|
|
171
|
-
> **Adjust Path:** The default destination is `./src/imgly`. Adjust the path to match your project structure.
|
|
172
|
-
|
|
173
|
-
The `imgly/` folder contains the editor configuration:
|
|
174
|
-
|
|
175
|
-
```
|
|
176
|
-
imgly/
|
|
177
|
-
├── config/
|
|
178
|
-
│ ├── design-editor/
|
|
179
|
-
│ │ ├── actions.ts # Export/import actions
|
|
180
|
-
│ │ ├── features.ts # Feature toggles
|
|
181
|
-
│ │ ├── i18n.ts # Translations
|
|
182
|
-
│ │ ├── plugin.ts # Main configuration plugin
|
|
183
|
-
│ │ ├── settings.ts # Engine settings
|
|
184
|
-
│ │ └── ui/
|
|
185
|
-
│ │ ├── canvas.ts # Canvas configuration
|
|
186
|
-
│ │ ├── components.ts # Custom component registration
|
|
187
|
-
│ │ ├── dock.ts # Dock layout configuration
|
|
188
|
-
│ │ ├── index.ts # Combines UI customization exports
|
|
189
|
-
│ │ ├── inspectorBar.ts # Inspector bar layout
|
|
190
|
-
│ │ ├── navigationBar.ts # Navigation bar layout
|
|
191
|
-
│ │ └── panel.ts # Panel configuration
|
|
192
|
-
│ ├── photo-editor/ # Same structure as design-editor/
|
|
193
|
-
│ └── video-editor/ # Same structure as design-editor/
|
|
194
|
-
├── index.ts # Editor initialization function
|
|
195
|
-
└── plugins/
|
|
196
|
-
└── ai-app/
|
|
197
|
-
├── ai-apps.ts
|
|
198
|
-
└── ai-providers.ts
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
## Step 2: Install Dependencies
|
|
202
|
-
|
|
203
|
-
Install the required packages for the editor:
|
|
204
|
-
|
|
205
|
-
### Core Editor
|
|
206
|
-
|
|
207
|
-
Install the Creative Editor SDK:
|
|
208
|
-
|
|
209
|
-
<TerminalTabs syncKey="package-manager">
|
|
210
|
-
<TerminalTab label="npm">
|
|
211
|
-
npm install @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
212
|
-
</TerminalTab>
|
|
213
|
-
|
|
214
|
-
<TerminalTab label="pnpm">
|
|
215
|
-
pnpm add @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
216
|
-
</TerminalTab>
|
|
217
|
-
|
|
218
|
-
<TerminalTab label="yarn">
|
|
219
|
-
yarn add @cesdk/cesdk-js@$UBQ\_VERSION$
|
|
220
|
-
</TerminalTab>
|
|
221
|
-
</TerminalTabs>
|
|
222
|
-
|
|
223
|
-
### AI Plugins
|
|
224
|
-
|
|
225
|
-
Add the AI Apps plugin and core generation utilities:
|
|
226
|
-
|
|
227
|
-
<TerminalTabs syncKey="package-manager">
|
|
228
|
-
<TerminalTab label="npm">
|
|
229
|
-
npm install @imgly/plugin-ai-apps-web@$UBQ\_VERSION$ @imgly/plugin-ai-generation-web@$UBQ\_VERSION$
|
|
230
|
-
</TerminalTab>
|
|
231
|
-
|
|
232
|
-
<TerminalTab label="pnpm">
|
|
233
|
-
pnpm add @imgly/plugin-ai-apps-web@$UBQ\_VERSION$ @imgly/plugin-ai-generation-web@$UBQ\_VERSION$
|
|
234
|
-
</TerminalTab>
|
|
235
|
-
|
|
236
|
-
<TerminalTab label="yarn">
|
|
237
|
-
yarn add @imgly/plugin-ai-apps-web@$UBQ\_VERSION$ @imgly/plugin-ai-generation-web@$UBQ\_VERSION$
|
|
238
|
-
</TerminalTab>
|
|
239
|
-
</TerminalTabs>
|
|
240
|
-
|
|
241
|
-
Add the image generation plugin for AI-powered image creation and editing:
|
|
242
|
-
|
|
243
|
-
<TerminalTabs syncKey="package-manager">
|
|
244
|
-
<TerminalTab label="npm">
|
|
245
|
-
npm install @imgly/plugin-ai-image-generation-web@$UBQ\_VERSION$
|
|
246
|
-
</TerminalTab>
|
|
247
|
-
|
|
248
|
-
<TerminalTab label="pnpm">
|
|
249
|
-
pnpm add @imgly/plugin-ai-image-generation-web@$UBQ\_VERSION$
|
|
250
|
-
</TerminalTab>
|
|
251
|
-
|
|
252
|
-
<TerminalTab label="yarn">
|
|
253
|
-
yarn add @imgly/plugin-ai-image-generation-web@$UBQ\_VERSION$
|
|
254
|
-
</TerminalTab>
|
|
255
|
-
</TerminalTabs>
|
|
256
|
-
|
|
257
|
-
Add the text generation plugin for AI-powered text content:
|
|
258
|
-
|
|
259
|
-
<TerminalTabs syncKey="package-manager">
|
|
260
|
-
<TerminalTab label="npm">
|
|
261
|
-
npm install @imgly/plugin-ai-text-generation-web@$UBQ\_VERSION$
|
|
262
|
-
</TerminalTab>
|
|
263
|
-
|
|
264
|
-
<TerminalTab label="pnpm">
|
|
265
|
-
pnpm add @imgly/plugin-ai-text-generation-web@$UBQ\_VERSION$
|
|
266
|
-
</TerminalTab>
|
|
267
|
-
|
|
268
|
-
<TerminalTab label="yarn">
|
|
269
|
-
yarn add @imgly/plugin-ai-text-generation-web@$UBQ\_VERSION$
|
|
270
|
-
</TerminalTab>
|
|
271
|
-
</TerminalTabs>
|
|
272
|
-
|
|
273
|
-
Add the video generation plugin for AI-powered video clips:
|
|
274
|
-
|
|
275
|
-
<TerminalTabs syncKey="package-manager">
|
|
276
|
-
<TerminalTab label="npm">
|
|
277
|
-
npm install @imgly/plugin-ai-video-generation-web@$UBQ\_VERSION$
|
|
278
|
-
</TerminalTab>
|
|
279
|
-
|
|
280
|
-
<TerminalTab label="pnpm">
|
|
281
|
-
pnpm add @imgly/plugin-ai-video-generation-web@$UBQ\_VERSION$
|
|
282
|
-
</TerminalTab>
|
|
283
|
-
|
|
284
|
-
<TerminalTab label="yarn">
|
|
285
|
-
yarn add @imgly/plugin-ai-video-generation-web@$UBQ\_VERSION$
|
|
286
|
-
</TerminalTab>
|
|
287
|
-
</TerminalTabs>
|
|
288
|
-
|
|
289
|
-
Add the audio generation plugin for AI-powered soundtracks and voiceovers:
|
|
290
|
-
|
|
291
|
-
<TerminalTabs syncKey="package-manager">
|
|
292
|
-
<TerminalTab label="npm">
|
|
293
|
-
npm install @imgly/plugin-ai-audio-generation-web@$UBQ\_VERSION$
|
|
294
|
-
</TerminalTab>
|
|
295
|
-
|
|
296
|
-
<TerminalTab label="pnpm">
|
|
297
|
-
pnpm add @imgly/plugin-ai-audio-generation-web@$UBQ\_VERSION$
|
|
298
|
-
</TerminalTab>
|
|
299
|
-
|
|
300
|
-
<TerminalTab label="yarn">
|
|
301
|
-
yarn add @imgly/plugin-ai-audio-generation-web@$UBQ\_VERSION$
|
|
302
|
-
</TerminalTab>
|
|
303
|
-
</TerminalTabs>
|
|
304
|
-
|
|
305
|
-
## Step 3: Download Assets
|
|
306
|
-
|
|
307
|
-
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
308
|
-
|
|
309
|
-
<TerminalTabs>
|
|
310
|
-
<TerminalTab label="Download">
|
|
311
|
-
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
312
|
-
unzip imgly-assets.zip -d public/
|
|
313
|
-
rm imgly-assets.zip
|
|
314
|
-
</TerminalTab>
|
|
315
|
-
</TerminalTabs>
|
|
316
|
-
|
|
317
|
-
> **Asset Configuration:** The starter kit is pre-configured to load assets from `/assets`. If you place assets in a different location, update the `baseURL` in Step 5: Initialize the Editor.
|
|
318
|
-
|
|
319
|
-
## Step 4: Add a Container Element
|
|
320
|
-
|
|
321
|
-
Add a container element to your HTML where the editor will be mounted:
|
|
322
|
-
|
|
323
|
-
```html
|
|
324
|
-
<div id="cesdk_container" style="width: 100%; height: 100vh;"></div>
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
## Step 5: Initialize the Editor
|
|
328
|
-
|
|
329
|
-
Choose your editing mode and initialize the editor accordingly:
|
|
330
|
-
|
|
331
|
-
<Tabs syncKey="editor-mode">
|
|
332
|
-
<TabItem label="Design">
|
|
333
|
-
```typescript title="src/index.tsx"
|
|
334
|
-
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
335
|
-
|
|
336
|
-
import { initAiDesignEditor, createAIProviders } from './imgly';
|
|
337
|
-
|
|
338
|
-
const config = {
|
|
339
|
-
userId: 'your-user-id',
|
|
340
|
-
baseURL: '/assets'
|
|
341
|
-
// license: 'YOUR_LICENSE_KEY',
|
|
342
|
-
};
|
|
343
|
-
|
|
344
|
-
CreativeEditorSDK.create('#cesdk_container', config)
|
|
345
|
-
.then(async (cesdk) => {
|
|
346
|
-
const providers = createAIProviders('Design');
|
|
347
|
-
await initAiDesignEditor(cesdk, providers);
|
|
348
|
-
})
|
|
349
|
-
.catch((error) => {
|
|
350
|
-
console.error('Failed to initialize CE.SDK:', error);
|
|
351
|
-
});
|
|
352
|
-
```
|
|
353
|
-
</TabItem>
|
|
354
|
-
|
|
355
|
-
<TabItem label="Photo">
|
|
356
|
-
```typescript title="src/index.tsx"
|
|
357
|
-
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
358
|
-
|
|
359
|
-
import { initAiPhotoEditor, createAIProviders } from './imgly';
|
|
360
|
-
|
|
361
|
-
const config = {
|
|
362
|
-
userId: 'your-user-id',
|
|
363
|
-
baseURL: '/assets'
|
|
364
|
-
// license: 'YOUR_LICENSE_KEY',
|
|
365
|
-
};
|
|
366
|
-
|
|
367
|
-
CreativeEditorSDK.create('#cesdk_container', config)
|
|
368
|
-
.then(async (cesdk) => {
|
|
369
|
-
const providers = createAIProviders('Photo');
|
|
370
|
-
await initAiPhotoEditor(cesdk, providers);
|
|
371
|
-
})
|
|
372
|
-
.catch((error) => {
|
|
373
|
-
console.error('Failed to initialize CE.SDK:', error);
|
|
374
|
-
});
|
|
375
|
-
```
|
|
376
|
-
</TabItem>
|
|
377
|
-
|
|
378
|
-
<TabItem label="Video">
|
|
379
|
-
```typescript title="src/index.tsx"
|
|
380
|
-
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
381
|
-
|
|
382
|
-
import { initAiVideoEditor, createAIProviders } from './imgly';
|
|
383
|
-
|
|
384
|
-
const config = {
|
|
385
|
-
userId: 'your-user-id',
|
|
386
|
-
baseURL: '/assets'
|
|
387
|
-
// license: 'YOUR_LICENSE_KEY',
|
|
388
|
-
};
|
|
389
|
-
|
|
390
|
-
CreativeEditorSDK.create('#cesdk_container', config)
|
|
391
|
-
.then(async (cesdk) => {
|
|
392
|
-
const providers = createAIProviders('Video');
|
|
393
|
-
await initAiVideoEditor(cesdk, providers);
|
|
394
|
-
})
|
|
395
|
-
.catch((error) => {
|
|
396
|
-
console.error('Failed to initialize CE.SDK:', error);
|
|
397
|
-
});
|
|
398
|
-
```
|
|
399
|
-
</TabItem>
|
|
400
|
-
</Tabs>
|
|
401
|
-
|
|
402
|
-
<br />
|
|
403
|
-
|
|
404
|
-
> **Remove Other Configs:** After choosing your mode, you can delete the unused configuration folders (e.g., if using Photo mode, delete `config/design-editor/` and `config/video-editor/`).
|
|
405
|
-
|
|
406
|
-
</TabItem>
|
|
407
|
-
</Tabs>
|
|
408
|
-
|
|
409
|
-
## Configure AI Providers
|
|
410
|
-
|
|
411
|
-
The AI Editor uses proxy URLs to securely connect to AI providers. Configure your proxy endpoints in the environment:
|
|
412
|
-
|
|
413
|
-
```env title=".env"
|
|
414
|
-
VITE_FAL_AI_PROXY_URL=https://your-server.com/api/proxy/falai
|
|
415
|
-
VITE_ANTHROPIC_PROXY_URL=https://your-server.com/api/proxy/anthropic
|
|
416
|
-
VITE_OPENAI_PROXY_URL=https://your-server.com/api/proxy/openai
|
|
417
|
-
VITE_ELEVENLABS_PROXY_URL=https://your-server.com/api/proxy/elevenlabs
|
|
418
|
-
```
|
|
419
|
-
|
|
420
|
-
> **Demo Proxies:** By default, the starter kit uses public IMG.LY demo proxies for quick testing. For production, set up your own proxy server to protect your API keys.
|
|
421
|
-
|
|
422
|
-
The AI provider configuration is managed in `src/imgly/plugins/ai-app/ai-providers.ts`:
|
|
423
|
-
|
|
424
|
-
```typescript title="src/imgly/plugins/ai-app/ai-providers.ts"
|
|
425
|
-
export function createAIProviders(mode: SceneMode): AIProviders {
|
|
426
|
-
return {
|
|
427
|
-
image: {
|
|
428
|
-
provider: 'fal.ai',
|
|
429
|
-
proxyUrl: import.meta.env.VITE_FAL_AI_PROXY_URL
|
|
430
|
-
},
|
|
431
|
-
video: {
|
|
432
|
-
provider: 'fal.ai',
|
|
433
|
-
proxyUrl: import.meta.env.VITE_FAL_AI_PROXY_URL
|
|
434
|
-
},
|
|
435
|
-
text: {
|
|
436
|
-
provider: 'anthropic',
|
|
437
|
-
proxyUrl: import.meta.env.VITE_ANTHROPIC_PROXY_URL
|
|
438
|
-
},
|
|
439
|
-
audio: {
|
|
440
|
-
provider: 'elevenlabs',
|
|
441
|
-
proxyUrl: import.meta.env.VITE_ELEVENLABS_PROXY_URL
|
|
442
|
-
}
|
|
443
|
-
};
|
|
444
|
-
}
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
See [AI Integration](./user-interface/ai-integration.md) for detailed provider setup and proxy server configuration.
|
|
448
|
-
|
|
449
|
-
## Set Up a Scene
|
|
450
|
-
|
|
451
|
-
CE.SDK offers multiple ways to load content into the editor. Choose the method that matches your use case:
|
|
452
|
-
|
|
453
|
-
```typescript title="src/imgly/config/index.ts"
|
|
454
|
-
// Create a blank design canvas - starts with an empty design scene
|
|
455
|
-
await cesdk.actions.run('scene.create');
|
|
456
|
-
|
|
457
|
-
// Load from a template archive - restores a previously saved project
|
|
458
|
-
await cesdk.loadFromArchiveURL('https://example.com/template.zip');
|
|
459
|
-
|
|
460
|
-
// Load from an image URL - creates a new scene with the image
|
|
461
|
-
await cesdk.createFromImage('https://example.com/image.jpg');
|
|
462
|
-
|
|
463
|
-
// Load from a scene file - restores a scene from JSON
|
|
464
|
-
await cesdk.loadFromURL('https://example.com/scene.json');
|
|
465
|
-
```
|
|
466
|
-
|
|
467
|
-
> **More Loading Options:** See [Open the Editor](./open-the-editor.md) for all available loading methods.
|
|
468
|
-
|
|
469
|
-
## Customize Assets
|
|
470
|
-
|
|
471
|
-
The AI Editor uses asset source plugins to provide built-in libraries for templates, stickers, shapes, and fonts. The starter kit includes a curated selection—customize what's included based on your needs.
|
|
472
|
-
|
|
473
|
-
Asset sources are added via plugins. Enable or disable individual sources:
|
|
474
|
-
|
|
475
|
-
```typescript title="src/imgly/config/design-editor/plugin.ts"
|
|
476
|
-
import {
|
|
477
|
-
FiltersAssetSource,
|
|
478
|
-
StickerAssetSource,
|
|
479
|
-
TextAssetSource,
|
|
480
|
-
VectorShapeAssetSource,
|
|
481
|
-
EffectsAssetSource
|
|
482
|
-
// ...
|
|
483
|
-
} from '@cesdk/cesdk-js/plugins';
|
|
484
|
-
|
|
485
|
-
// Add only the sources you need
|
|
486
|
-
await cesdk.addPlugin(new FiltersAssetSource());
|
|
487
|
-
await cesdk.addPlugin(new StickerAssetSource());
|
|
488
|
-
await cesdk.addPlugin(new TextAssetSource());
|
|
489
|
-
await cesdk.addPlugin(new VectorShapeAssetSource());
|
|
490
|
-
await cesdk.addPlugin(new EffectsAssetSource());
|
|
491
|
-
// ...
|
|
492
|
-
```
|
|
493
|
-
|
|
494
|
-
> **Available Asset Sources:** See [Asset Source Plugins](./plugins/asset-sources.md) for the complete list of available sources.
|
|
495
|
-
|
|
496
|
-
For production deployments, self-hosting assets is required—the IMG.LY CDN is intended for development only. See [Serve Assets](./serve-assets.md) for downloading assets, configuring `baseURL`, and excluding unused sources to optimize load times.
|
|
497
|
-
|
|
498
|
-
## Configure Actions
|
|
499
|
-
|
|
500
|
-
Actions are functions that handle user interactions like exporting designs, saving scenes, and importing files. CE.SDK provides built-in actions that you can run directly or override with custom implementations.
|
|
501
|
-
|
|
502
|
-
**Key built-in actions:**
|
|
503
|
-
|
|
504
|
-
- `exportDesign` – Export the current design to PNG, JPEG, PDF, or other formats
|
|
505
|
-
- `saveScene` – Save the scene as a JSON string for later editing
|
|
506
|
-
- `importScene` – Import a previously saved scene (supports `.scene` and `.cesdk` formats)
|
|
507
|
-
- `exportScene` – Export the scene as a JSON file or `.cesdk` archive with all assets
|
|
508
|
-
- `uploadFile` – Handle file uploads with progress tracking
|
|
509
|
-
|
|
510
|
-
Use `cesdk.actions.run()` to execute any action:
|
|
511
|
-
|
|
512
|
-
```typescript
|
|
513
|
-
// Run a built-in action
|
|
514
|
-
await cesdk.actions.run('exportDesign', { mimeType: 'image/png' });
|
|
515
|
-
```
|
|
516
|
-
|
|
517
|
-
#### Import from File Picker
|
|
518
|
-
|
|
519
|
-
```typescript title="src/imgly/config/design-editor/actions.ts"
|
|
520
|
-
// Let users open images from their device
|
|
521
|
-
cesdk.actions.register('importImage', async () => {
|
|
522
|
-
const blobURL = await cesdk.utils.loadFile({
|
|
523
|
-
accept: 'image/*',
|
|
524
|
-
returnType: 'objectURL'
|
|
525
|
-
});
|
|
526
|
-
await cesdk.createFromImage(blobURL);
|
|
527
|
-
});
|
|
528
|
-
```
|
|
529
|
-
|
|
530
|
-
#### Export and Save
|
|
531
|
-
|
|
532
|
-
```typescript title="src/imgly/config/design-editor/actions.ts"
|
|
533
|
-
// Register export action that downloads the edited design
|
|
534
|
-
cesdk.actions.register('exportDesign', async (exportOptions) => {
|
|
535
|
-
const { blobs, options } = await cesdk.utils.export(exportOptions);
|
|
536
|
-
await cesdk.utils.downloadFile(blobs[0], options.mimeType);
|
|
537
|
-
});
|
|
538
|
-
```
|
|
539
|
-
|
|
540
|
-
> **Learn More:** See [Actions](./actions.md) for the full list of built-in actions, how to run them, and how to register custom actions.
|
|
541
|
-
|
|
542
|
-
---
|
|
543
|
-
|
|
544
|
-
## Customize (Optional)
|
|
545
|
-
|
|
546
|
-
### Theming
|
|
547
|
-
|
|
548
|
-
CE.SDK supports light and dark themes out of the box, plus automatic system preference detection. Switch between themes programmatically:
|
|
549
|
-
|
|
550
|
-
```typescript title="src/imgly/config/design-editor/settings.ts"
|
|
551
|
-
// 'light' | 'dark' | 'system' | (() => 'light' | 'dark')
|
|
552
|
-
cesdk.ui.setTheme('dark');
|
|
553
|
-
```
|
|
554
|
-
|
|
555
|
-
See [Theming](./user-interface/appearance/theming.md) for custom color schemes, CSS variables, and advanced styling options.
|
|
556
|
-
|
|
557
|
-
### Localization
|
|
558
|
-
|
|
559
|
-
Customize UI labels and add support for multiple languages. The i18n system supports translation keys for all UI elements:
|
|
560
|
-
|
|
561
|
-
```typescript title="src/imgly/config/design-editor/i18n.ts"
|
|
562
|
-
// Override specific labels
|
|
563
|
-
cesdk.i18n.setTranslations({
|
|
564
|
-
en: {
|
|
565
|
-
'actions.export.image': 'Download Design',
|
|
566
|
-
'common.cancel': 'Cancel',
|
|
567
|
-
'common.apply': 'Apply'
|
|
568
|
-
}
|
|
569
|
-
});
|
|
570
|
-
|
|
571
|
-
// Set the active locale
|
|
572
|
-
cesdk.i18n.setLocale('de');
|
|
573
|
-
```
|
|
574
|
-
|
|
575
|
-
See [Localization](./user-interface/localization.md) for supported languages, translation key reference, and right-to-left language support.
|
|
576
|
-
|
|
577
|
-
### UI Layout
|
|
578
|
-
|
|
579
|
-

|
|
580
|
-
|
|
581
|
-
Customize the editor interface by modifying the dock, inspector bar, navigation bar, and canvas menu. CE.SDK provides Order APIs to control which components appear and in what sequence.
|
|
582
|
-
|
|
583
|
-
See [Dock](./user-interface/customization/dock.md), [Inspector Bar](./user-interface/customization/inspector-bar.md), [Navigation Bar](./user-interface/customization/navigation-bar.md), [Canvas Menu](./user-interface/customization/canvas-menu.md), and [Canvas](./user-interface/customization/canvas.md) for detailed layout customization options.
|
|
584
|
-
|
|
585
|
-
### Settings & Features
|
|
586
|
-
|
|
587
|
-
Fine-tune editor behavior through settings and features.
|
|
588
|
-
|
|
589
|
-
**Settings** configure core engine behavior—rendering, input handling, and history management:
|
|
590
|
-
|
|
591
|
-
```typescript title="src/imgly/config/design-editor/settings.ts"
|
|
592
|
-
cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', true);
|
|
593
|
-
cesdk.engine.editor.setSettingBool('mouse/enableZoomControl', true);
|
|
594
|
-
```
|
|
595
|
-
|
|
596
|
-
**Features** toggle which editing tools and panels appear in the UI:
|
|
597
|
-
|
|
598
|
-
```typescript title="src/imgly/config/design-editor/features.ts"
|
|
599
|
-
// Toggle editor features
|
|
600
|
-
cesdk.feature.enable('ly.img.crop', true);
|
|
601
|
-
cesdk.feature.enable('ly.img.filter', true);
|
|
602
|
-
cesdk.feature.enable('ly.img.adjustment', true);
|
|
603
|
-
```
|
|
604
|
-
|
|
605
|
-
See [Settings](./settings.md) and [Features](./user-interface/customization/disable-or-enable.md) for the complete reference.
|
|
606
|
-
|
|
607
|
-
### Explore Plugins
|
|
608
|
-
|
|
609
|
-
CE.SDK has a rich plugin ecosystem that extends the editor with powerful capabilities.
|
|
610
|
-
|
|
611
|
-
#### AI Generation
|
|
612
|
-
|
|
613
|
-
The AI Editor uses multiple plugins for different generation capabilities:
|
|
614
|
-
|
|
615
|
-
- `@imgly/plugin-ai-apps-web` - Main AI Apps interface
|
|
616
|
-
- `@imgly/plugin-ai-generation-web` - Core generation utilities
|
|
617
|
-
- `@imgly/plugin-ai-image-generation-web` - Image generation (fal.ai, OpenAI)
|
|
618
|
-
- `@imgly/plugin-ai-text-generation-web` - Text generation (Anthropic, OpenAI)
|
|
619
|
-
- `@imgly/plugin-ai-video-generation-web` - Video generation (fal.ai)
|
|
620
|
-
- `@imgly/plugin-ai-audio-generation-web` - Audio generation (ElevenLabs)
|
|
621
|
-
|
|
622
|
-
```typescript title="src/imgly/plugins/ai-app/ai-apps.ts"
|
|
623
|
-
import AiApps from '@imgly/plugin-ai-apps-web';
|
|
624
|
-
import FalAiImage from '@imgly/plugin-ai-image-generation-web/fal-ai';
|
|
625
|
-
import Anthropic from '@imgly/plugin-ai-text-generation-web/anthropic';
|
|
626
|
-
import FalAiVideo from '@imgly/plugin-ai-video-generation-web/fal-ai';
|
|
627
|
-
import Elevenlabs from '@imgly/plugin-ai-audio-generation-web/elevenlabs';
|
|
628
|
-
|
|
629
|
-
await cesdk.addPlugin(
|
|
630
|
-
AiApps({
|
|
631
|
-
providers: {
|
|
632
|
-
text2image: FalAiImage({ proxyUrl: '...' }),
|
|
633
|
-
text2text: Anthropic({ proxyUrl: '...' }),
|
|
634
|
-
text2video: FalAiVideo({ proxyUrl: '...' }),
|
|
635
|
-
text2audio: Elevenlabs({ proxyUrl: '...' })
|
|
636
|
-
}
|
|
637
|
-
})
|
|
638
|
-
);
|
|
639
|
-
```
|
|
640
|
-
|
|
641
|
-
See [AI Integration](./user-interface/ai-integration.md) for provider setup and supported AI features.
|
|
642
|
-
|
|
643
|
-
#### Background Removal
|
|
644
|
-
|
|
645
|
-
Add AI-powered background removal that runs entirely client-side:
|
|
646
|
-
|
|
647
|
-
```typescript title="src/imgly/plugins/background-removal.ts"
|
|
648
|
-
import BackgroundRemovalPlugin from '@imgly/plugin-background-removal';
|
|
649
|
-
|
|
650
|
-
await cesdk.addPlugin(BackgroundRemovalPlugin());
|
|
651
|
-
```
|
|
652
|
-
|
|
653
|
-
See [Background Removal](./edit-image/remove-bg.md) for setup instructions and configuration options.
|
|
654
|
-
|
|
655
|
-
---
|
|
656
|
-
|
|
657
|
-
## Key Capabilities
|
|
658
|
-
|
|
659
|
-
The AI Editor includes everything needed for AI-powered creative editing.
|
|
660
|
-
|
|
661
|
-
<CapabilityGrid
|
|
662
|
-
features={[
|
|
663
|
-
{
|
|
664
|
-
title: 'Image Generation',
|
|
665
|
-
description:
|
|
666
|
-
'Generate images from text prompts or transform existing images with AI-powered styles and effects.',
|
|
667
|
-
imageId: 'effects',
|
|
668
|
-
},
|
|
669
|
-
{
|
|
670
|
-
title: 'Video Generation',
|
|
671
|
-
description:
|
|
672
|
-
'Create short video clips from images or prompts with AI-powered animation and effects.',
|
|
673
|
-
imageId: 'transform',
|
|
674
|
-
},
|
|
675
|
-
{
|
|
676
|
-
title: 'Audio Generation',
|
|
677
|
-
description:
|
|
678
|
-
'Generate royalty-free soundtracks and audio effects from text descriptions.',
|
|
679
|
-
imageId: 'audio',
|
|
680
|
-
},
|
|
681
|
-
{
|
|
682
|
-
title: 'Voice Generation',
|
|
683
|
-
description:
|
|
684
|
-
'Create natural-sounding voiceovers from text scripts with adjustable speed and voice selection.',
|
|
685
|
-
imageId: 'text-editing',
|
|
686
|
-
},
|
|
687
|
-
{
|
|
688
|
-
title: 'Background Removal',
|
|
689
|
-
description:
|
|
690
|
-
'AI-powered background removal that runs entirely in the browser without server dependencies.',
|
|
691
|
-
imageId: 'green-screen',
|
|
692
|
-
},
|
|
693
|
-
{
|
|
694
|
-
title: 'Multi-Mode Editing',
|
|
695
|
-
description:
|
|
696
|
-
'Switch between Design, Photo, and Video editing modes with optimized configurations for each.',
|
|
697
|
-
imageId: 'filters',
|
|
698
|
-
},
|
|
699
|
-
]}
|
|
700
|
-
/>
|
|
701
|
-
|
|
702
|
-
<br />
|
|
703
|
-
|
|
704
|
-
> **Free Trial:** [Sign up for a free trial](https://img.ly/forms/free-trial) to get a license key and remove the watermark.
|
|
705
|
-
|
|
706
|
-
---
|
|
707
|
-
|
|
708
|
-
## Troubleshooting
|
|
709
|
-
|
|
710
|
-
### Editor doesn't load
|
|
711
|
-
|
|
712
|
-
- **Check the container element exists**: Ensure your container element is in the DOM before calling `create()`
|
|
713
|
-
- **Verify the baseURL**: Assets must be accessible from the CDN or your self-hosted location
|
|
714
|
-
- **Check console errors**: Look for CORS or network errors in browser developer tools
|
|
715
|
-
|
|
716
|
-
### AI generation fails
|
|
717
|
-
|
|
718
|
-
- **Check proxy configuration**: Ensure your proxy URLs are correctly configured in `.env`
|
|
719
|
-
- **Verify API keys**: Make sure your AI provider API keys are valid and have sufficient credits
|
|
720
|
-
- **Check network requests**: Open DevTools Network tab and look for failed requests to your proxy server
|
|
721
|
-
|
|
722
|
-
### Assets don't appear
|
|
723
|
-
|
|
724
|
-
- **Check network requests**: Open DevTools Network tab and look for failed requests to `cdn.img.ly`
|
|
725
|
-
- **Self-host assets for production**: See [Serve Assets](./serve-assets.md) to host assets on your infrastructure
|
|
726
|
-
|
|
727
|
-
### Watermark appears in production
|
|
728
|
-
|
|
729
|
-
- **Add your license key**: Set the `license` property in your configuration
|
|
730
|
-
- **Sign up for a trial**: Get a free trial license at [img.ly/forms/free-trial](https://img.ly/forms/free-trial)
|
|
731
|
-
|
|
732
|
-
---
|
|
733
|
-
|
|
734
|
-
## Next Steps
|
|
735
|
-
|
|
736
|
-
- [AI Integration](./user-interface/ai-integration.md) – Configure AI providers and proxy servers
|
|
737
|
-
- [Configuration](./configuration.md) – Complete list of initialization options
|
|
738
|
-
- [Serve Assets](./serve-assets.md) – Self-host engine assets for production
|
|
739
|
-
- [Actions](./actions.md) – Build custom export and save workflows
|
|
740
|
-
- [Theming](./user-interface/appearance/theming.md) – Customize colors and appearance
|
|
741
|
-
|
|
742
|
-
---
|
|
743
|
-
|
|
744
|
-
## More Resources
|
|
745
|
-
|
|
746
|
-
- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
|
|
747
|
-
- **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
|
|
748
|
-
- **[Web Documentation](./js.md)** - Interactive documentation with examples
|
|
749
|
-
- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
|