@imgly/codesign-mcp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +16 -0
- package/README.md +158 -0
- package/assets/docs/api/SKILL.md +49 -0
- package/assets/docs/api/index.d.ts +10518 -0
- package/assets/docs/guide/SKILL.md +142 -0
- package/assets/docs/guide/actions.md +1038 -0
- package/assets/docs/guide/animation/create/base.md +467 -0
- package/assets/docs/guide/animation/create/text.md +453 -0
- package/assets/docs/guide/animation/create.md +558 -0
- package/assets/docs/guide/animation/edit.md +501 -0
- package/assets/docs/guide/animation/overview.md +22 -0
- package/assets/docs/guide/animation/types.md +430 -0
- package/assets/docs/guide/animation.md +23 -0
- package/assets/docs/guide/api/AssetAPI.md +602 -0
- package/assets/docs/guide/api/BlockAPI.md +6152 -0
- package/assets/docs/guide/api/CreativeEngine.md +180 -0
- package/assets/docs/guide/api/EditorAPI.md +1261 -0
- package/assets/docs/guide/api/EventAPI.md +25 -0
- package/assets/docs/guide/api/SceneAPI.md +729 -0
- package/assets/docs/guide/api/VariableAPI.md +59 -0
- package/assets/docs/guide/api/types.md +71 -0
- package/assets/docs/guide/api-reference/overview.md +20 -0
- package/assets/docs/guide/automation/auto-resize.md +412 -0
- package/assets/docs/guide/automation/batch-processing.md +474 -0
- package/assets/docs/guide/automation/data-merge.md +406 -0
- package/assets/docs/guide/automation/design-generation.md +107 -0
- package/assets/docs/guide/automation/overview.md +16 -0
- package/assets/docs/guide/automation.md +24 -0
- package/assets/docs/guide/browser-support.md +38 -0
- package/assets/docs/guide/capabilities.md +18 -0
- package/assets/docs/guide/colors/adjust.md +551 -0
- package/assets/docs/guide/colors/apply.md +349 -0
- package/assets/docs/guide/colors/basics.md +440 -0
- package/assets/docs/guide/colors/conversion.md +504 -0
- package/assets/docs/guide/colors/create-color-palette.md +426 -0
- package/assets/docs/guide/colors/for-print/cmyk.md +577 -0
- package/assets/docs/guide/colors/for-print/spot.md +751 -0
- package/assets/docs/guide/colors/for-print.md +21 -0
- package/assets/docs/guide/colors/for-screen/p3.md +60 -0
- package/assets/docs/guide/colors/for-screen/srgb.md +463 -0
- package/assets/docs/guide/colors/for-screen.md +21 -0
- package/assets/docs/guide/colors/overview.md +20 -0
- package/assets/docs/guide/colors/replace.md +535 -0
- package/assets/docs/guide/colors.md +28 -0
- package/assets/docs/guide/compatibility.md +27 -0
- package/assets/docs/guide/concepts/architecture.md +99 -0
- package/assets/docs/guide/concepts/assets.md +360 -0
- package/assets/docs/guide/concepts/blocks.md +750 -0
- package/assets/docs/guide/concepts/buffers.md +546 -0
- package/assets/docs/guide/concepts/design-units.md +333 -0
- package/assets/docs/guide/concepts/edit-modes.md +431 -0
- package/assets/docs/guide/concepts/editing-workflow.md +303 -0
- package/assets/docs/guide/concepts/events.md +466 -0
- package/assets/docs/guide/concepts/headless-mode/browser.md +291 -0
- package/assets/docs/guide/concepts/pages.md +396 -0
- package/assets/docs/guide/concepts/resources.md +496 -0
- package/assets/docs/guide/concepts/scenes.md +443 -0
- package/assets/docs/guide/concepts/templating.md +194 -0
- package/assets/docs/guide/concepts/terminology.md +296 -0
- package/assets/docs/guide/concepts/undo-and-history.md +461 -0
- package/assets/docs/guide/concepts.md +38 -0
- package/assets/docs/guide/configuration.md +469 -0
- package/assets/docs/guide/conversion/overview.md +22 -0
- package/assets/docs/guide/conversion/to-base64.md +234 -0
- package/assets/docs/guide/conversion/to-pdf.md +616 -0
- package/assets/docs/guide/conversion/to-png.md +290 -0
- package/assets/docs/guide/conversion.md +23 -0
- package/assets/docs/guide/create-audio/audio/add-music.md +430 -0
- package/assets/docs/guide/create-audio/audio/add-sound-effects.md +664 -0
- package/assets/docs/guide/create-audio/audio/loop.md +370 -0
- package/assets/docs/guide/create-audio/audio.md +336 -0
- package/assets/docs/guide/create-composition/add-background.md +395 -0
- package/assets/docs/guide/create-composition/blend-modes.md +372 -0
- package/assets/docs/guide/create-composition/collage.md +432 -0
- package/assets/docs/guide/create-composition/group-and-ungroup.md +388 -0
- package/assets/docs/guide/create-composition/layer-management.md +503 -0
- package/assets/docs/guide/create-composition/layout.md +396 -0
- package/assets/docs/guide/create-composition/lock-design.md +362 -0
- package/assets/docs/guide/create-composition/multi-page.md +204 -0
- package/assets/docs/guide/create-composition/overview.md +18 -0
- package/assets/docs/guide/create-composition/programmatic.md +593 -0
- package/assets/docs/guide/create-composition.md +30 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +688 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +600 -0
- package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +647 -0
- package/assets/docs/guide/create-templates/add-dynamic-content.md +307 -0
- package/assets/docs/guide/create-templates/add-to-template-library.md +297 -0
- package/assets/docs/guide/create-templates/edit-or-remove.md +441 -0
- package/assets/docs/guide/create-templates/from-scratch.md +558 -0
- package/assets/docs/guide/create-templates/import/from-scene-file.md +440 -0
- package/assets/docs/guide/create-templates/import.md +244 -0
- package/assets/docs/guide/create-templates/lock.md +325 -0
- package/assets/docs/guide/create-templates/overview.md +16 -0
- package/assets/docs/guide/create-templates.md +32 -0
- package/assets/docs/guide/create-video/audio/adjust-speed.md +302 -0
- package/assets/docs/guide/create-video/audio/adjust-volume.md +346 -0
- package/assets/docs/guide/create-video/control.md +285 -0
- package/assets/docs/guide/create-video/limitations.md +396 -0
- package/assets/docs/guide/create-video/overview.md +224 -0
- package/assets/docs/guide/create-video/timeline-editor.md +622 -0
- package/assets/docs/guide/create-video/update-caption-presets.md +676 -0
- package/assets/docs/guide/create-video.md +32 -0
- package/assets/docs/guide/edit-image/add-watermark.md +497 -0
- package/assets/docs/guide/edit-image/overview.md +22 -0
- package/assets/docs/guide/edit-image/remove-bg.md +420 -0
- package/assets/docs/guide/edit-image/replace-colors.md +680 -0
- package/assets/docs/guide/edit-image/transform/crop.md +523 -0
- package/assets/docs/guide/edit-image/transform/move.md +279 -0
- package/assets/docs/guide/edit-image/transform/resize.md +301 -0
- package/assets/docs/guide/edit-image/transform/rotate.md +408 -0
- package/assets/docs/guide/edit-image/transform/scale.md +278 -0
- package/assets/docs/guide/edit-image/transform.md +24 -0
- package/assets/docs/guide/edit-image/vectorize.md +204 -0
- package/assets/docs/guide/edit-image.md +25 -0
- package/assets/docs/guide/edit-video/add-captions.md +589 -0
- package/assets/docs/guide/edit-video/add-watermark.md +429 -0
- package/assets/docs/guide/edit-video/join-and-arrange.md +540 -0
- package/assets/docs/guide/edit-video/redaction.md +544 -0
- package/assets/docs/guide/edit-video/split.md +634 -0
- package/assets/docs/guide/edit-video/transform/crop.md +380 -0
- package/assets/docs/guide/edit-video/transform/flip.md +182 -0
- package/assets/docs/guide/edit-video/transform/move.md +413 -0
- package/assets/docs/guide/edit-video/transform/resize.md +534 -0
- package/assets/docs/guide/edit-video/transform/rotate.md +312 -0
- package/assets/docs/guide/edit-video/transform/scale.md +603 -0
- package/assets/docs/guide/edit-video/transform.md +25 -0
- package/assets/docs/guide/edit-video/trim.md +773 -0
- package/assets/docs/guide/engine-interface.md +108 -0
- package/assets/docs/guide/export-save-publish/create-thumbnail.md +292 -0
- package/assets/docs/guide/export-save-publish/export/compress.md +639 -0
- package/assets/docs/guide/export-save-publish/export/overview.md +576 -0
- package/assets/docs/guide/export-save-publish/export/partial-export.md +694 -0
- package/assets/docs/guide/export-save-publish/export/size-limits.md +401 -0
- package/assets/docs/guide/export-save-publish/export/to-html5.md +474 -0
- package/assets/docs/guide/export-save-publish/export/to-jpeg.md +312 -0
- package/assets/docs/guide/export-save-publish/export/to-mp4.md +364 -0
- package/assets/docs/guide/export-save-publish/export/to-pdf.md +389 -0
- package/assets/docs/guide/export-save-publish/export/to-png.md +255 -0
- package/assets/docs/guide/export-save-publish/export/to-raw-data.md +303 -0
- package/assets/docs/guide/export-save-publish/export/to-webp.md +261 -0
- package/assets/docs/guide/export-save-publish/export/with-color-mask.md +278 -0
- package/assets/docs/guide/export-save-publish/export.md +36 -0
- package/assets/docs/guide/export-save-publish/for-printing.md +423 -0
- package/assets/docs/guide/export-save-publish/for-social-media.md +318 -0
- package/assets/docs/guide/export-save-publish/pre-export-validation.md +698 -0
- package/assets/docs/guide/export-save-publish/save.md +340 -0
- package/assets/docs/guide/export-save-publish/store-custom-metadata.md +367 -0
- package/assets/docs/guide/file-format-support.md +34 -0
- package/assets/docs/guide/fills/color.md +678 -0
- package/assets/docs/guide/fills/image.md +539 -0
- package/assets/docs/guide/fills/overview.md +144 -0
- package/assets/docs/guide/fills/video.md +641 -0
- package/assets/docs/guide/fills.md +24 -0
- package/assets/docs/guide/filters-and-effects/apply.md +1019 -0
- package/assets/docs/guide/filters-and-effects/blur.md +382 -0
- package/assets/docs/guide/filters-and-effects/chroma-key-green-screen.md +445 -0
- package/assets/docs/guide/filters-and-effects/create-custom-filters.md +614 -0
- package/assets/docs/guide/filters-and-effects/create-custom-lut-filter.md +426 -0
- package/assets/docs/guide/filters-and-effects/distortion.md +527 -0
- package/assets/docs/guide/filters-and-effects/duotone.md +602 -0
- package/assets/docs/guide/filters-and-effects/gradients.md +1311 -0
- package/assets/docs/guide/filters-and-effects/overview.md +22 -0
- package/assets/docs/guide/filters-and-effects/support.md +623 -0
- package/assets/docs/guide/filters-and-effects.md +28 -0
- package/assets/docs/guide/get-started/agent-skills.md +119 -0
- package/assets/docs/guide/get-started/build-with-ai.md +45 -0
- package/assets/docs/guide/get-started/mcp-server.md +119 -0
- package/assets/docs/guide/get-started/overview.md +28 -0
- package/assets/docs/guide/get-started/vanilla-js/quickstart.md +175 -0
- package/assets/docs/guide/grid-and-rulers.md +222 -0
- package/assets/docs/guide/guides/export-save-publish/export/audio.md +224 -0
- package/assets/docs/guide/guides/text/rendering-internals.md +796 -0
- package/assets/docs/guide/guides.md +49 -0
- package/assets/docs/guide/import-media/asset-library.md +23 -0
- package/assets/docs/guide/import-media/asset-panel/basics.md +324 -0
- package/assets/docs/guide/import-media/asset-panel/customize.md +478 -0
- package/assets/docs/guide/import-media/asset-panel/refresh-assets.md +415 -0
- package/assets/docs/guide/import-media/asset-panel/thumbnails.md +633 -0
- package/assets/docs/guide/import-media/capture-from-camera/record-video.md +137 -0
- package/assets/docs/guide/import-media/capture-from-camera.md +20 -0
- package/assets/docs/guide/import-media/concepts.md +173 -0
- package/assets/docs/guide/import-media/content-json-schema.md +615 -0
- package/assets/docs/guide/import-media/default-assets.md +381 -0
- package/assets/docs/guide/import-media/edit-or-remove-assets.md +489 -0
- package/assets/docs/guide/import-media/file-format-support.md +178 -0
- package/assets/docs/guide/import-media/from-local-source/user-upload.md +438 -0
- package/assets/docs/guide/import-media/from-local-source.md +20 -0
- package/assets/docs/guide/import-media/from-remote-source/asset-versioning.md +390 -0
- package/assets/docs/guide/import-media/from-remote-source/getty-images.md +627 -0
- package/assets/docs/guide/import-media/from-remote-source/imgly-premium-assets.md +625 -0
- package/assets/docs/guide/import-media/from-remote-source/pexels.md +692 -0
- package/assets/docs/guide/import-media/from-remote-source/remote-asset.md +473 -0
- package/assets/docs/guide/import-media/from-remote-source/soundstripe.md +497 -0
- package/assets/docs/guide/import-media/from-remote-source/third-party.md +51 -0
- package/assets/docs/guide/import-media/from-remote-source/unsplash.md +914 -0
- package/assets/docs/guide/import-media/from-remote-source/your-server.md +764 -0
- package/assets/docs/guide/import-media/from-remote-source.md +28 -0
- package/assets/docs/guide/import-media/overview.md +32 -0
- package/assets/docs/guide/import-media/retrieve-mimetype.md +274 -0
- package/assets/docs/guide/import-media/size-limits.md +20 -0
- package/assets/docs/guide/import-media/source-sets.md +476 -0
- package/assets/docs/guide/import-media.md +32 -0
- package/assets/docs/guide/insert-media/audio.md +291 -0
- package/assets/docs/guide/insert-media/images.md +380 -0
- package/assets/docs/guide/insert-media/position-and-align.md +734 -0
- package/assets/docs/guide/insert-media/shapes-or-stickers.md +799 -0
- package/assets/docs/guide/insert-media/videos.md +308 -0
- package/assets/docs/guide/insert-media.md +24 -0
- package/assets/docs/guide/key-capabilities.md +24 -0
- package/assets/docs/guide/key-concepts.md +83 -0
- package/assets/docs/guide/licensing.md +45 -0
- package/assets/docs/guide/llms-txt.md +53 -0
- package/assets/docs/guide/open-the-editor/blank-canvas.md +124 -0
- package/assets/docs/guide/open-the-editor/from-htmlcanvas.md +228 -0
- package/assets/docs/guide/open-the-editor/from-image.md +205 -0
- package/assets/docs/guide/open-the-editor/from-template.md +189 -0
- package/assets/docs/guide/open-the-editor/from-video.md +274 -0
- package/assets/docs/guide/open-the-editor/import-design/from-archive.md +504 -0
- package/assets/docs/guide/open-the-editor/import-design/from-indesign.md +680 -0
- package/assets/docs/guide/open-the-editor/import-design/from-photoshop.md +865 -0
- package/assets/docs/guide/open-the-editor/import-design.md +481 -0
- package/assets/docs/guide/open-the-editor/load-scene.md +178 -0
- package/assets/docs/guide/open-the-editor/overview.md +20 -0
- package/assets/docs/guide/open-the-editor/set-zoom-level.md +303 -0
- package/assets/docs/guide/open-the-editor/uri-resolver.md +347 -0
- package/assets/docs/guide/open-the-editor.md +29 -0
- package/assets/docs/guide/outlines/overview.md +14 -0
- package/assets/docs/guide/outlines/shadows-and-glows.md +515 -0
- package/assets/docs/guide/outlines/strokes.md +292 -0
- package/assets/docs/guide/outlines.md +22 -0
- package/assets/docs/guide/overview.md +22 -0
- package/assets/docs/guide/performance.md +217 -0
- package/assets/docs/guide/plugins/asset-sources.md +553 -0
- package/assets/docs/guide/plugins/print-ready-pdf.md +549 -0
- package/assets/docs/guide/plugins.md +36 -0
- package/assets/docs/guide/rules/asset-handling.md +180 -0
- package/assets/docs/guide/rules/common-pitfalls.md +272 -0
- package/assets/docs/guide/rules/content-fill-mode.md +29 -0
- package/assets/docs/guide/rules/enforce-brand-guidelines.md +672 -0
- package/assets/docs/guide/rules/lock-content.md +478 -0
- package/assets/docs/guide/rules/moderate-content.md +761 -0
- package/assets/docs/guide/rules/overview.md +514 -0
- package/assets/docs/guide/rules/silent-init-errors.md +137 -0
- package/assets/docs/guide/rules/verify-properties-before-use.md +78 -0
- package/assets/docs/guide/rules.md +23 -0
- package/assets/docs/guide/security.md +199 -0
- package/assets/docs/guide/serve-assets.md +332 -0
- package/assets/docs/guide/settings.md +199 -0
- package/assets/docs/guide/shapes.md +23 -0
- package/assets/docs/guide/starterkits/3d-mockup-editor.md +748 -0
- package/assets/docs/guide/starterkits/advanced-editor.md +698 -0
- package/assets/docs/guide/starterkits/advanced-video-editor.md +696 -0
- package/assets/docs/guide/starterkits/ai-editor.md +749 -0
- package/assets/docs/guide/starterkits/airtable-image-editor.md +672 -0
- package/assets/docs/guide/starterkits/apparel-ui.md +188 -0
- package/assets/docs/guide/starterkits/assets.md +27 -0
- package/assets/docs/guide/starterkits/auto-resize.md +586 -0
- package/assets/docs/guide/starterkits/automated-video-generation.md +692 -0
- package/assets/docs/guide/starterkits/background-removal-editor.md +480 -0
- package/assets/docs/guide/starterkits/content-moderation.md +863 -0
- package/assets/docs/guide/starterkits/creative-automation.md +28 -0
- package/assets/docs/guide/starterkits/custom-built-uis.md +26 -0
- package/assets/docs/guide/starterkits/customization.md +29 -0
- package/assets/docs/guide/starterkits/cutout-lines-editor.md +470 -0
- package/assets/docs/guide/starterkits/data-merge.md +850 -0
- package/assets/docs/guide/starterkits/design-editor.md +698 -0
- package/assets/docs/guide/starterkits/design-generation.md +719 -0
- package/assets/docs/guide/starterkits/design-validation.md +808 -0
- package/assets/docs/guide/starterkits/editor-ui-configurations.md +14 -0
- package/assets/docs/guide/starterkits/export-options.md +724 -0
- package/assets/docs/guide/starterkits/export-using-renderer.md +708 -0
- package/assets/docs/guide/starterkits/extensibility.md +28 -0
- package/assets/docs/guide/starterkits/force-crop-editor.md +675 -0
- package/assets/docs/guide/starterkits/form-based-template-adoption.md +522 -0
- package/assets/docs/guide/starterkits/getty-images-editor.md +700 -0
- package/assets/docs/guide/starterkits/html5-ads-exporter.md +719 -0
- package/assets/docs/guide/starterkits/indesign-template-import.md +580 -0
- package/assets/docs/guide/starterkits/layouts-editor.md +724 -0
- package/assets/docs/guide/starterkits/mobile-ui.md +185 -0
- package/assets/docs/guide/starterkits/mockup-editor.md +745 -0
- package/assets/docs/guide/starterkits/multi-image-generation.md +542 -0
- package/assets/docs/guide/starterkits/page-sizes-editor.md +657 -0
- package/assets/docs/guide/starterkits/pexels-image-editor.md +665 -0
- package/assets/docs/guide/starterkits/photo-editor.md +755 -0
- package/assets/docs/guide/starterkits/photo-ui.md +186 -0
- package/assets/docs/guide/starterkits/photobook-ui.md +188 -0
- package/assets/docs/guide/starterkits/placeholders.md +678 -0
- package/assets/docs/guide/starterkits/player.md +405 -0
- package/assets/docs/guide/starterkits/plugins.md +25 -0
- package/assets/docs/guide/starterkits/postcard-editor.md +202 -0
- package/assets/docs/guide/starterkits/pptx-template-import.md +581 -0
- package/assets/docs/guide/starterkits/print-ready-pdf-editor.md +746 -0
- package/assets/docs/guide/starterkits/product-editor.md +773 -0
- package/assets/docs/guide/starterkits/psd-template-import.md +580 -0
- package/assets/docs/guide/starterkits/qr-code-editor.md +470 -0
- package/assets/docs/guide/starterkits/single-page-editor.md +661 -0
- package/assets/docs/guide/starterkits/start-with-image.md +684 -0
- package/assets/docs/guide/starterkits/start-with-video.md +651 -0
- package/assets/docs/guide/starterkits/t-shirt-designer.md +742 -0
- package/assets/docs/guide/starterkits/templating.md +23 -0
- package/assets/docs/guide/starterkits/theming.md +662 -0
- package/assets/docs/guide/starterkits/translation-internationalization.md +662 -0
- package/assets/docs/guide/starterkits/unsplash-editor.md +839 -0
- package/assets/docs/guide/starterkits/vectorizer-editor.md +466 -0
- package/assets/docs/guide/starterkits/version-history.md +745 -0
- package/assets/docs/guide/starterkits/video-animations.md +853 -0
- package/assets/docs/guide/starterkits/video-captions.md +884 -0
- package/assets/docs/guide/starterkits/video-editing.md +25 -0
- package/assets/docs/guide/starterkits/video-editor.md +696 -0
- package/assets/docs/guide/starterkits/video-export-options.md +676 -0
- package/assets/docs/guide/starterkits/viewer.md +400 -0
- package/assets/docs/guide/starterkits.md +41 -0
- package/assets/docs/guide/stickers-and-shapes/combine.md +743 -0
- package/assets/docs/guide/stickers-and-shapes/create-cutout.md +425 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-shapes.md +794 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/create-stickers.md +290 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/edit-shapes.md +211 -0
- package/assets/docs/guide/stickers-and-shapes/create-edit/vector-edit.md +362 -0
- package/assets/docs/guide/stickers-and-shapes/insert-qr-code.md +208 -0
- package/assets/docs/guide/stickers.md +21 -0
- package/assets/docs/guide/text/add.md +641 -0
- package/assets/docs/guide/text/adjust-spacing.md +288 -0
- package/assets/docs/guide/text/auto-size.md +404 -0
- package/assets/docs/guide/text/custom-fonts.md +401 -0
- package/assets/docs/guide/text/decorations.md +330 -0
- package/assets/docs/guide/text/edit.md +458 -0
- package/assets/docs/guide/text/effects.md +244 -0
- package/assets/docs/guide/text/emojis.md +310 -0
- package/assets/docs/guide/text/enumerations.md +258 -0
- package/assets/docs/guide/text/language-support.md +604 -0
- package/assets/docs/guide/text/overview.md +14 -0
- package/assets/docs/guide/text/styling.md +390 -0
- package/assets/docs/guide/text/text-designs.md +834 -0
- package/assets/docs/guide/text.md +33 -0
- package/assets/docs/guide/to-v1-10.md +131 -0
- package/assets/docs/guide/to-v1-13.md +165 -0
- package/assets/docs/guide/to-v1-19.md +315 -0
- package/assets/docs/guide/to-v1-32.md +110 -0
- package/assets/docs/guide/to-v1-69.md +468 -0
- package/assets/docs/guide/to-v1-72.md +193 -0
- package/assets/docs/guide/upgrade.md +25 -0
- package/assets/docs/guide/use-templates/apply-template.md +279 -0
- package/assets/docs/guide/use-templates/generate.md +405 -0
- package/assets/docs/guide/use-templates/library.md +450 -0
- package/assets/docs/guide/use-templates/overview.md +20 -0
- package/assets/docs/guide/use-templates/programmatic.md +482 -0
- package/assets/docs/guide/use-templates/replace-content.md +399 -0
- package/assets/docs/guide/user-interface/ai-integration/audio-generation.md +428 -0
- package/assets/docs/guide/user-interface/ai-integration/auto-captions.md +337 -0
- package/assets/docs/guide/user-interface/ai-integration/custom-provider.md +853 -0
- package/assets/docs/guide/user-interface/ai-integration/gateway-provider.md +1045 -0
- package/assets/docs/guide/user-interface/ai-integration/image-generation.md +641 -0
- package/assets/docs/guide/user-interface/ai-integration/integrate.md +966 -0
- package/assets/docs/guide/user-interface/ai-integration/proxy-server.md +99 -0
- package/assets/docs/guide/user-interface/ai-integration/text-generation.md +498 -0
- package/assets/docs/guide/user-interface/ai-integration/video-generation.md +493 -0
- package/assets/docs/guide/user-interface/ai-integration.md +30 -0
- package/assets/docs/guide/user-interface/appearance/change-ui-font.md +316 -0
- package/assets/docs/guide/user-interface/appearance/custom-labels.md +509 -0
- package/assets/docs/guide/user-interface/appearance/icons.md +373 -0
- package/assets/docs/guide/user-interface/appearance/theming.md +665 -0
- package/assets/docs/guide/user-interface/appearance.md +23 -0
- package/assets/docs/guide/user-interface/build-your-own-ui.md +620 -0
- package/assets/docs/guide/user-interface/customization/canvas-menu.md +412 -0
- package/assets/docs/guide/user-interface/customization/canvas.md +281 -0
- package/assets/docs/guide/user-interface/customization/color-palette.md +413 -0
- package/assets/docs/guide/user-interface/customization/crop-presets.md +384 -0
- package/assets/docs/guide/user-interface/customization/disable-or-enable.md +676 -0
- package/assets/docs/guide/user-interface/customization/dock.md +399 -0
- package/assets/docs/guide/user-interface/customization/force-crop.md +289 -0
- package/assets/docs/guide/user-interface/customization/inspector-bar.md +371 -0
- package/assets/docs/guide/user-interface/customization/navigation-bar.md +516 -0
- package/assets/docs/guide/user-interface/customization/page-format.md +436 -0
- package/assets/docs/guide/user-interface/customization/panel.md +605 -0
- package/assets/docs/guide/user-interface/customization/quick-start/add-action-buttons.md +531 -0
- package/assets/docs/guide/user-interface/customization/quick-start/add-dock-buttons.md +358 -0
- package/assets/docs/guide/user-interface/customization/quick-start/create-custom-components.md +374 -0
- package/assets/docs/guide/user-interface/customization/quick-start/reorder-components.md +323 -0
- package/assets/docs/guide/user-interface/customization/quick-start/show-hide-components.md +294 -0
- package/assets/docs/guide/user-interface/customization/quick-start.md +12 -0
- package/assets/docs/guide/user-interface/customization/reference/component-order-api.md +519 -0
- package/assets/docs/guide/user-interface/customization/reference/component-reference.md +333 -0
- package/assets/docs/guide/user-interface/customization/reference.md +12 -0
- package/assets/docs/guide/user-interface/customization.md +39 -0
- package/assets/docs/guide/user-interface/localization.md +633 -0
- package/assets/docs/guide/user-interface/overview.md +167 -0
- package/assets/docs/guide/user-interface/ui-extensions/add-custom-feature.md +411 -0
- package/assets/docs/guide/user-interface/ui-extensions/asset-library.md +721 -0
- package/assets/docs/guide/user-interface/ui-extensions/create-custom-panel.md +331 -0
- package/assets/docs/guide/user-interface/ui-extensions/customize-behaviour.md +553 -0
- package/assets/docs/guide/user-interface/ui-extensions/notifications-and-dialogs.md +672 -0
- package/assets/docs/guide/user-interface/ui-extensions/quick-actions.md +415 -0
- package/assets/docs/guide/user-interface/ui-extensions/register-new-component.md +521 -0
- package/assets/docs/guide/user-interface/ui-extensions.md +26 -0
- package/assets/docs/guide/user-interface.md +25 -0
- package/assets/docs/guide/what-is-cesdk.md +319 -0
- package/assets/docs/handbook/SKILL.md +521 -0
- package/assets/prompts/evals-assetGenerate.md +12 -0
- package/assets/prompts/evals-brutalistCore.md +34 -0
- package/assets/prompts/evals-danskCatalogue.md +31 -0
- package/assets/prompts/evals-exportRoundTrip.md +12 -0
- package/assets/prompts/evals-inspectPriorCode.md +16 -0
- package/assets/prompts/evals-listProjectFiles.md +6 -0
- package/assets/prompts/evals-readAndExplainScript.md +6 -0
- package/assets/prompts/evals-resumeAcrossRestart.md +15 -0
- package/assets/prompts/evals-rewindRecovery.md +10 -0
- package/assets/prompts/evals-searchAcrossFiles.md +6 -0
- package/assets/prompts/evals-weddingCard.md +20 -0
- package/assets/prompts/explain.md +6 -0
- package/assets/prompts/review.md +6 -0
- package/dist/assets/inline.generated.d.ts +2 -0
- package/dist/assets/inline.generated.d.ts.map +1 -0
- package/dist/assets/inline.generated.js +413 -0
- package/dist/assets/inline.generated.js.map +1 -0
- package/dist/assets/load-browser.d.ts +8 -0
- package/dist/assets/load-browser.d.ts.map +1 -0
- package/dist/assets/load-browser.js +11 -0
- package/dist/assets/load-browser.js.map +1 -0
- package/dist/assets/load-node.d.ts +8 -0
- package/dist/assets/load-node.d.ts.map +1 -0
- package/dist/assets/load-node.js +11 -0
- package/dist/assets/load-node.js.map +1 -0
- package/dist/cli/http.d.ts +2 -0
- package/dist/cli/http.d.ts.map +1 -0
- package/dist/cli/http.js +231 -0
- package/dist/cli/http.js.map +1 -0
- package/dist/cli/redirect-console.d.ts +10 -0
- package/dist/cli/redirect-console.d.ts.map +1 -0
- package/dist/cli/redirect-console.js +18 -0
- package/dist/cli/redirect-console.js.map +1 -0
- package/dist/cli/resolve-license.d.ts +2 -0
- package/dist/cli/resolve-license.d.ts.map +1 -0
- package/dist/cli/resolve-license.js +13 -0
- package/dist/cli/resolve-license.js.map +1 -0
- package/dist/cli/stdio.d.ts +2 -0
- package/dist/cli/stdio.d.ts.map +1 -0
- package/dist/cli/stdio.js +124 -0
- package/dist/cli/stdio.js.map +1 -0
- package/dist/cli/trial-license.generated.d.ts +2 -0
- package/dist/cli/trial-license.generated.d.ts.map +1 -0
- package/dist/cli/trial-license.generated.js +4 -0
- package/dist/cli/trial-license.generated.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +64 -0
- package/dist/cli.js.map +1 -0
- package/dist/config.d.ts +61 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +102 -0
- package/dist/config.js.map +1 -0
- package/dist/cross-ref.d.ts +2 -0
- package/dist/cross-ref.d.ts.map +1 -0
- package/dist/cross-ref.js +31 -0
- package/dist/cross-ref.js.map +1 -0
- package/dist/dashboard/router.d.ts +3 -0
- package/dist/dashboard/router.d.ts.map +1 -0
- package/dist/dashboard/router.js +19 -0
- package/dist/dashboard/router.js.map +1 -0
- package/dist/dashboard/spa-assets.generated.d.ts +2 -0
- package/dist/dashboard/spa-assets.generated.d.ts.map +1 -0
- package/dist/dashboard/spa-assets.generated.js +220 -0
- package/dist/dashboard/spa-assets.generated.js.map +1 -0
- package/dist/engine/asset-sources.d.ts +17 -0
- package/dist/engine/asset-sources.d.ts.map +1 -0
- package/dist/engine/asset-sources.js +75 -0
- package/dist/engine/asset-sources.js.map +1 -0
- package/dist/engine/cesdk-adapter.d.ts +10 -0
- package/dist/engine/cesdk-adapter.d.ts.map +1 -0
- package/dist/engine/cesdk-adapter.js +19 -0
- package/dist/engine/cesdk-adapter.js.map +1 -0
- package/dist/engine/index.d.ts +3 -0
- package/dist/engine/index.d.ts.map +1 -0
- package/dist/engine/index.js +3 -0
- package/dist/engine/index.js.map +1 -0
- package/dist/engine/mutex.d.ts +5 -0
- package/dist/engine/mutex.d.ts.map +1 -0
- package/dist/engine/mutex.js +42 -0
- package/dist/engine/mutex.js.map +1 -0
- package/dist/engine/session.d.ts +50 -0
- package/dist/engine/session.d.ts.map +1 -0
- package/dist/engine/session.js +95 -0
- package/dist/engine/session.js.map +1 -0
- package/dist/engine/uri-resolver.d.ts +14 -0
- package/dist/engine/uri-resolver.d.ts.map +1 -0
- package/dist/engine/uri-resolver.js +12 -0
- package/dist/engine/uri-resolver.js.map +1 -0
- package/dist/frontmatter.d.ts +15 -0
- package/dist/frontmatter.d.ts.map +1 -0
- package/dist/frontmatter.js +46 -0
- package/dist/frontmatter.js.map +1 -0
- package/dist/gateway/hosted-stub.d.ts +6 -0
- package/dist/gateway/hosted-stub.d.ts.map +1 -0
- package/dist/gateway/hosted-stub.js +11 -0
- package/dist/gateway/hosted-stub.js.map +1 -0
- package/dist/gateway/index.d.ts +4 -0
- package/dist/gateway/index.d.ts.map +1 -0
- package/dist/gateway/index.js +4 -0
- package/dist/gateway/index.js.map +1 -0
- package/dist/gateway/local.d.ts +14 -0
- package/dist/gateway/local.d.ts.map +1 -0
- package/dist/gateway/local.js +41 -0
- package/dist/gateway/local.js.map +1 -0
- package/dist/gateway/types.d.ts +24 -0
- package/dist/gateway/types.d.ts.map +1 -0
- package/dist/gateway/types.js +7 -0
- package/dist/gateway/types.js.map +1 -0
- package/dist/http/server.d.ts +80 -0
- package/dist/http/server.d.ts.map +1 -0
- package/dist/http/server.js +183 -0
- package/dist/http/server.js.map +1 -0
- package/dist/http/session-manager.d.ts +42 -0
- package/dist/http/session-manager.d.ts.map +1 -0
- package/dist/http/session-manager.js +82 -0
- package/dist/http/session-manager.js.map +1 -0
- package/dist/http/workspace-auth.d.ts +9 -0
- package/dist/http/workspace-auth.d.ts.map +1 -0
- package/dist/http/workspace-auth.js +29 -0
- package/dist/http/workspace-auth.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/metrics/mount.d.ts +11 -0
- package/dist/metrics/mount.d.ts.map +1 -0
- package/dist/metrics/mount.js +13 -0
- package/dist/metrics/mount.js.map +1 -0
- package/dist/metrics/recorder.d.ts +55 -0
- package/dist/metrics/recorder.d.ts.map +1 -0
- package/dist/metrics/recorder.js +97 -0
- package/dist/metrics/recorder.js.map +1 -0
- package/dist/revisions/hash.d.ts +7 -0
- package/dist/revisions/hash.d.ts.map +1 -0
- package/dist/revisions/hash.js +24 -0
- package/dist/revisions/hash.js.map +1 -0
- package/dist/revisions/index.d.ts +4 -0
- package/dist/revisions/index.d.ts.map +1 -0
- package/dist/revisions/index.js +4 -0
- package/dist/revisions/index.js.map +1 -0
- package/dist/revisions/store.d.ts +69 -0
- package/dist/revisions/store.d.ts.map +1 -0
- package/dist/revisions/store.js +196 -0
- package/dist/revisions/store.js.map +1 -0
- package/dist/revisions/types.d.ts +39 -0
- package/dist/revisions/types.d.ts.map +1 -0
- package/dist/revisions/types.js +2 -0
- package/dist/revisions/types.js.map +1 -0
- package/dist/server.d.ts +51 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +175 -0
- package/dist/server.js.map +1 -0
- package/dist/skill-tools.d.ts +3 -0
- package/dist/skill-tools.d.ts.map +1 -0
- package/dist/skill-tools.js +105 -0
- package/dist/skill-tools.js.map +1 -0
- package/dist/test/test/cli/dispatcher.test.d.ts +2 -0
- package/dist/test/test/cli/dispatcher.test.d.ts.map +1 -0
- package/dist/test/test/cli/dispatcher.test.js +47 -0
- package/dist/test/test/cli/dispatcher.test.js.map +1 -0
- package/dist/test/test/cross-ref.test.d.ts +2 -0
- package/dist/test/test/cross-ref.test.d.ts.map +1 -0
- package/dist/test/test/cross-ref.test.js +39 -0
- package/dist/test/test/cross-ref.test.js.map +1 -0
- package/dist/test/test/engine/session.test.d.ts +2 -0
- package/dist/test/test/engine/session.test.d.ts.map +1 -0
- package/dist/test/test/engine/session.test.js +144 -0
- package/dist/test/test/engine/session.test.js.map +1 -0
- package/dist/test/test/engine/uri-resolver.test.d.ts +2 -0
- package/dist/test/test/engine/uri-resolver.test.d.ts.map +1 -0
- package/dist/test/test/engine/uri-resolver.test.js +38 -0
- package/dist/test/test/engine/uri-resolver.test.js.map +1 -0
- package/dist/test/test/frontmatter.test.d.ts +2 -0
- package/dist/test/test/frontmatter.test.d.ts.map +1 -0
- package/dist/test/test/frontmatter.test.js +55 -0
- package/dist/test/test/frontmatter.test.js.map +1 -0
- package/dist/test/test/gateway/hosted-stub.test.d.ts +2 -0
- package/dist/test/test/gateway/hosted-stub.test.d.ts.map +1 -0
- package/dist/test/test/gateway/hosted-stub.test.js +11 -0
- package/dist/test/test/gateway/hosted-stub.test.js.map +1 -0
- package/dist/test/test/gateway/local.test.d.ts +2 -0
- package/dist/test/test/gateway/local.test.d.ts.map +1 -0
- package/dist/test/test/gateway/local.test.js +29 -0
- package/dist/test/test/gateway/local.test.js.map +1 -0
- package/dist/test/test/handbook-contract.test.d.ts +2 -0
- package/dist/test/test/handbook-contract.test.d.ts.map +1 -0
- package/dist/test/test/handbook-contract.test.js +71 -0
- package/dist/test/test/handbook-contract.test.js.map +1 -0
- package/dist/test/test/http/server.test.d.ts +2 -0
- package/dist/test/test/http/server.test.d.ts.map +1 -0
- package/dist/test/test/http/server.test.js +245 -0
- package/dist/test/test/http/server.test.js.map +1 -0
- package/dist/test/test/http/session-manager.test.d.ts +2 -0
- package/dist/test/test/http/session-manager.test.d.ts.map +1 -0
- package/dist/test/test/http/session-manager.test.js +83 -0
- package/dist/test/test/http/session-manager.test.js.map +1 -0
- package/dist/test/test/revisions/hash.test.d.ts +2 -0
- package/dist/test/test/revisions/hash.test.d.ts.map +1 -0
- package/dist/test/test/revisions/hash.test.js +33 -0
- package/dist/test/test/revisions/hash.test.js.map +1 -0
- package/dist/test/test/revisions/store.test.d.ts +2 -0
- package/dist/test/test/revisions/store.test.d.ts.map +1 -0
- package/dist/test/test/revisions/store.test.js +245 -0
- package/dist/test/test/revisions/store.test.js.map +1 -0
- package/dist/test/test/server.test.d.ts +2 -0
- package/dist/test/test/server.test.d.ts.map +1 -0
- package/dist/test/test/server.test.js +157 -0
- package/dist/test/test/server.test.js.map +1 -0
- package/dist/test/test/skill-tools.test.d.ts +2 -0
- package/dist/test/test/skill-tools.test.d.ts.map +1 -0
- package/dist/test/test/skill-tools.test.js +84 -0
- package/dist/test/test/skill-tools.test.js.map +1 -0
- package/dist/test/test/smoke.test.d.ts +2 -0
- package/dist/test/test/smoke.test.d.ts.map +1 -0
- package/dist/test/test/smoke.test.js +8 -0
- package/dist/test/test/smoke.test.js.map +1 -0
- package/dist/test/test/tools/asset-generate.test.d.ts +2 -0
- package/dist/test/test/tools/asset-generate.test.d.ts.map +1 -0
- package/dist/test/test/tools/asset-generate.test.js +66 -0
- package/dist/test/test/tools/asset-generate.test.js.map +1 -0
- package/dist/test/test/tools/edit.test.d.ts +2 -0
- package/dist/test/test/tools/edit.test.d.ts.map +1 -0
- package/dist/test/test/tools/edit.test.js +205 -0
- package/dist/test/test/tools/edit.test.js.map +1 -0
- package/dist/test/test/tools/export.test.d.ts +2 -0
- package/dist/test/test/tools/export.test.d.ts.map +1 -0
- package/dist/test/test/tools/export.test.js +144 -0
- package/dist/test/test/tools/export.test.js.map +1 -0
- package/dist/test/test/tools/history.test.d.ts +2 -0
- package/dist/test/test/tools/history.test.d.ts.map +1 -0
- package/dist/test/test/tools/history.test.js +29 -0
- package/dist/test/test/tools/history.test.js.map +1 -0
- package/dist/test/test/tools/inspect.test.d.ts +2 -0
- package/dist/test/test/tools/inspect.test.d.ts.map +1 -0
- package/dist/test/test/tools/inspect.test.js +62 -0
- package/dist/test/test/tools/inspect.test.js.map +1 -0
- package/dist/test/test/tools/list.test.d.ts +2 -0
- package/dist/test/test/tools/list.test.d.ts.map +1 -0
- package/dist/test/test/tools/list.test.js +23 -0
- package/dist/test/test/tools/list.test.js.map +1 -0
- package/dist/test/test/tools/open-editor.test.d.ts +2 -0
- package/dist/test/test/tools/open-editor.test.d.ts.map +1 -0
- package/dist/test/test/tools/open-editor.test.js +53 -0
- package/dist/test/test/tools/open-editor.test.js.map +1 -0
- package/dist/test/test/tools/preview.test.d.ts +2 -0
- package/dist/test/test/tools/preview.test.d.ts.map +1 -0
- package/dist/test/test/tools/preview.test.js +73 -0
- package/dist/test/test/tools/preview.test.js.map +1 -0
- package/dist/test/test/tools/rename.test.d.ts +2 -0
- package/dist/test/test/tools/rename.test.d.ts.map +1 -0
- package/dist/test/test/tools/rename.test.js +17 -0
- package/dist/test/test/tools/rename.test.js.map +1 -0
- package/dist/test/test/viewer/broadcaster.test.d.ts +2 -0
- package/dist/test/test/viewer/broadcaster.test.d.ts.map +1 -0
- package/dist/test/test/viewer/broadcaster.test.js +53 -0
- package/dist/test/test/viewer/broadcaster.test.js.map +1 -0
- package/dist/test/test/viewer/resource-route.test.d.ts +2 -0
- package/dist/test/test/viewer/resource-route.test.d.ts.map +1 -0
- package/dist/test/test/viewer/resource-route.test.js +70 -0
- package/dist/test/test/viewer/resource-route.test.js.map +1 -0
- package/dist/test/test/viewer/router.test.d.ts +2 -0
- package/dist/test/test/viewer/router.test.d.ts.map +1 -0
- package/dist/test/test/viewer/router.test.js +171 -0
- package/dist/test/test/viewer/router.test.js.map +1 -0
- package/dist/test/test/viewer/url-builder.test.d.ts +2 -0
- package/dist/test/test/viewer/url-builder.test.d.ts.map +1 -0
- package/dist/test/test/viewer/url-builder.test.js +31 -0
- package/dist/test/test/viewer/url-builder.test.js.map +1 -0
- package/dist/test/test/workspace/hosted-stub.test.d.ts +2 -0
- package/dist/test/test/workspace/hosted-stub.test.d.ts.map +1 -0
- package/dist/test/test/workspace/hosted-stub.test.js +30 -0
- package/dist/test/test/workspace/hosted-stub.test.js.map +1 -0
- package/dist/test/test/workspace/in-memory.test.d.ts +2 -0
- package/dist/test/test/workspace/in-memory.test.d.ts.map +1 -0
- package/dist/test/test/workspace/in-memory.test.js +4 -0
- package/dist/test/test/workspace/in-memory.test.js.map +1 -0
- package/dist/test/test/workspace/node-fs.test.d.ts +2 -0
- package/dist/test/test/workspace/node-fs.test.d.ts.map +1 -0
- package/dist/test/test/workspace/node-fs.test.js +20 -0
- package/dist/test/test/workspace/node-fs.test.js.map +1 -0
- package/dist/test/test/workspace/shared-contract.d.ts +3 -0
- package/dist/test/test/workspace/shared-contract.d.ts.map +1 -0
- package/dist/test/test/workspace/shared-contract.js +92 -0
- package/dist/test/test/workspace/shared-contract.js.map +1 -0
- package/dist/test/tsconfig.test.tsbuildinfo +1 -0
- package/dist/test/vitest.config.d.ts +3 -0
- package/dist/test/vitest.config.d.ts.map +1 -0
- package/dist/test/vitest.config.js +8 -0
- package/dist/test/vitest.config.js.map +1 -0
- package/dist/tools/asset-generate.d.ts +12 -0
- package/dist/tools/asset-generate.d.ts.map +1 -0
- package/dist/tools/asset-generate.js +112 -0
- package/dist/tools/asset-generate.js.map +1 -0
- package/dist/tools/asset-search.d.ts +10 -0
- package/dist/tools/asset-search.d.ts.map +1 -0
- package/dist/tools/asset-search.js +120 -0
- package/dist/tools/asset-search.js.map +1 -0
- package/dist/tools/content-types.d.ts +11 -0
- package/dist/tools/content-types.d.ts.map +1 -0
- package/dist/tools/content-types.js +2 -0
- package/dist/tools/content-types.js.map +1 -0
- package/dist/tools/edit.d.ts +29 -0
- package/dist/tools/edit.d.ts.map +1 -0
- package/dist/tools/edit.js +165 -0
- package/dist/tools/edit.js.map +1 -0
- package/dist/tools/engine.d.ts +31 -0
- package/dist/tools/engine.d.ts.map +1 -0
- package/dist/tools/engine.js +59 -0
- package/dist/tools/engine.js.map +1 -0
- package/dist/tools/export.d.ts +19 -0
- package/dist/tools/export.d.ts.map +1 -0
- package/dist/tools/export.js +179 -0
- package/dist/tools/export.js.map +1 -0
- package/dist/tools/history.d.ts +7 -0
- package/dist/tools/history.d.ts.map +1 -0
- package/dist/tools/history.js +54 -0
- package/dist/tools/history.js.map +1 -0
- package/dist/tools/index.d.ts +35 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +72 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/inspect.d.ts +7 -0
- package/dist/tools/inspect.d.ts.map +1 -0
- package/dist/tools/inspect.js +80 -0
- package/dist/tools/inspect.js.map +1 -0
- package/dist/tools/list.d.ts +7 -0
- package/dist/tools/list.d.ts.map +1 -0
- package/dist/tools/list.js +18 -0
- package/dist/tools/list.js.map +1 -0
- package/dist/tools/metrics.d.ts +11 -0
- package/dist/tools/metrics.d.ts.map +1 -0
- package/dist/tools/metrics.js +28 -0
- package/dist/tools/metrics.js.map +1 -0
- package/dist/tools/open-editor.d.ts +10 -0
- package/dist/tools/open-editor.d.ts.map +1 -0
- package/dist/tools/open-editor.js +62 -0
- package/dist/tools/open-editor.js.map +1 -0
- package/dist/tools/preview.d.ts +12 -0
- package/dist/tools/preview.d.ts.map +1 -0
- package/dist/tools/preview.js +104 -0
- package/dist/tools/preview.js.map +1 -0
- package/dist/tools/rename.d.ts +7 -0
- package/dist/tools/rename.d.ts.map +1 -0
- package/dist/tools/rename.js +39 -0
- package/dist/tools/rename.js.map +1 -0
- package/dist/tools/result.d.ts +12 -0
- package/dist/tools/result.d.ts.map +1 -0
- package/dist/tools/result.js +55 -0
- package/dist/tools/result.js.map +1 -0
- package/dist/tools/save.d.ts +19 -0
- package/dist/tools/save.d.ts.map +1 -0
- package/dist/tools/save.js +117 -0
- package/dist/tools/save.js.map +1 -0
- package/dist/viewer/broadcaster.d.ts +13 -0
- package/dist/viewer/broadcaster.d.ts.map +1 -0
- package/dist/viewer/broadcaster.js +44 -0
- package/dist/viewer/broadcaster.js.map +1 -0
- package/dist/viewer/index.d.ts +7 -0
- package/dist/viewer/index.d.ts.map +1 -0
- package/dist/viewer/index.js +7 -0
- package/dist/viewer/index.js.map +1 -0
- package/dist/viewer/listener.d.ts +16 -0
- package/dist/viewer/listener.d.ts.map +1 -0
- package/dist/viewer/listener.js +30 -0
- package/dist/viewer/listener.js.map +1 -0
- package/dist/viewer/presigned-r2-url-builder.d.ts +30 -0
- package/dist/viewer/presigned-r2-url-builder.d.ts.map +1 -0
- package/dist/viewer/presigned-r2-url-builder.js +40 -0
- package/dist/viewer/presigned-r2-url-builder.js.map +1 -0
- package/dist/viewer/resource-route.d.ts +9 -0
- package/dist/viewer/resource-route.d.ts.map +1 -0
- package/dist/viewer/resource-route.js +59 -0
- package/dist/viewer/resource-route.js.map +1 -0
- package/dist/viewer/router.d.ts +20 -0
- package/dist/viewer/router.d.ts.map +1 -0
- package/dist/viewer/router.js +142 -0
- package/dist/viewer/router.js.map +1 -0
- package/dist/viewer/session-mount.d.ts +10 -0
- package/dist/viewer/session-mount.d.ts.map +1 -0
- package/dist/viewer/session-mount.js +24 -0
- package/dist/viewer/session-mount.js.map +1 -0
- package/dist/viewer/spa-assets.generated.d.ts +2 -0
- package/dist/viewer/spa-assets.generated.d.ts.map +1 -0
- package/dist/viewer/spa-assets.generated.js +989 -0
- package/dist/viewer/spa-assets.generated.js.map +1 -0
- package/dist/viewer/url-builder.d.ts +48 -0
- package/dist/viewer/url-builder.d.ts.map +1 -0
- package/dist/viewer/url-builder.js +38 -0
- package/dist/viewer/url-builder.js.map +1 -0
- package/dist/workspace/hosted-stub.d.ts +28 -0
- package/dist/workspace/hosted-stub.d.ts.map +1 -0
- package/dist/workspace/hosted-stub.js +44 -0
- package/dist/workspace/hosted-stub.js.map +1 -0
- package/dist/workspace/in-memory.d.ts +23 -0
- package/dist/workspace/in-memory.d.ts.map +1 -0
- package/dist/workspace/in-memory.js +161 -0
- package/dist/workspace/in-memory.js.map +1 -0
- package/dist/workspace/index.d.ts +6 -0
- package/dist/workspace/index.d.ts.map +1 -0
- package/dist/workspace/index.js +6 -0
- package/dist/workspace/index.js.map +1 -0
- package/dist/workspace/node-fs.d.ts +23 -0
- package/dist/workspace/node-fs.d.ts.map +1 -0
- package/dist/workspace/node-fs.js +90 -0
- package/dist/workspace/node-fs.js.map +1 -0
- package/dist/workspace/s3.d.ts +32 -0
- package/dist/workspace/s3.d.ts.map +1 -0
- package/dist/workspace/s3.js +191 -0
- package/dist/workspace/s3.js.map +1 -0
- package/dist/workspace/scoped.d.ts +32 -0
- package/dist/workspace/scoped.d.ts.map +1 -0
- package/dist/workspace/scoped.js +76 -0
- package/dist/workspace/scoped.js.map +1 -0
- package/dist/workspace/types.d.ts +75 -0
- package/dist/workspace/types.d.ts.map +1 -0
- package/dist/workspace/types.js +18 -0
- package/dist/workspace/types.js.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,692 @@
|
|
|
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) > [Video Editing](./starterkits/video-editing.md) > [Automated Video Generation](./starterkits/automated-video-generation.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Streamline asset production with video placeholders.
|
|
8
|
+
|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
> **Reading time:** 10 minutes
|
|
12
|
+
>
|
|
13
|
+
> **Resources:**
|
|
14
|
+
>
|
|
15
|
+
> - [Download examples](https://github.com/imgly/starterkit-video-placeholders-react-web/archive/refs/tags/release-$UBQ_VERSION$.zip)
|
|
16
|
+
> - [View source on GitHub](https://github.com/imgly/starterkit-video-placeholders-react-web/tree/release-$UBQ_VERSION$)
|
|
17
|
+
> - [Open in StackBlitz](https://stackblitz.com/github/imgly/starterkit-video-placeholders-react-web/tree/release-$UBQ_VERSION$)
|
|
18
|
+
> - [Live demo](https://img.ly/docs/cesdk/examples/starterkit-video-placeholders/)
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Pre-requisites
|
|
23
|
+
|
|
24
|
+
This guide assumes basic familiarity with JavaScript or 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 Automated Video Generation project. This creates a complete, ready-to-run application.
|
|
37
|
+
|
|
38
|
+
## Step 1: Clone the Repository
|
|
39
|
+
|
|
40
|
+
<TerminalTabs>
|
|
41
|
+
<TerminalTab label="git">
|
|
42
|
+
git clone https://github.com/imgly/starterkit-video-placeholders-react-web.git
|
|
43
|
+
</TerminalTab>
|
|
44
|
+
|
|
45
|
+
<TerminalTab label="degit">
|
|
46
|
+
npx degit imgly/starterkit-video-placeholders-react-web starterkit-video-placeholders-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
|
+
│ │ ├── advanced-video-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
|
+
│ │ └── video-editor/ # Same structure as advanced-video-editor/
|
|
72
|
+
│ └── index.ts # Editor initialization function
|
|
73
|
+
└── index.tsx # Application entry point
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Step 2: Install Dependencies
|
|
77
|
+
|
|
78
|
+
Install the required packages:
|
|
79
|
+
|
|
80
|
+
<TerminalTabs syncKey="package-manager">
|
|
81
|
+
<TerminalTab label="npm">
|
|
82
|
+
cd starterkit-video-placeholders-react-web
|
|
83
|
+
npm install
|
|
84
|
+
</TerminalTab>
|
|
85
|
+
|
|
86
|
+
<TerminalTab label="pnpm">
|
|
87
|
+
cd starterkit-video-placeholders-react-web
|
|
88
|
+
pnpm install
|
|
89
|
+
</TerminalTab>
|
|
90
|
+
|
|
91
|
+
<TerminalTab label="yarn">
|
|
92
|
+
cd starterkit-video-placeholders-react-web
|
|
93
|
+
yarn
|
|
94
|
+
</TerminalTab>
|
|
95
|
+
</TerminalTabs>
|
|
96
|
+
|
|
97
|
+
## Step 3: Download Assets
|
|
98
|
+
|
|
99
|
+
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
100
|
+
|
|
101
|
+
<TerminalTabs>
|
|
102
|
+
<TerminalTab label="Download">
|
|
103
|
+
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
104
|
+
unzip imgly-assets.zip -d public/
|
|
105
|
+
rm imgly-assets.zip
|
|
106
|
+
</TerminalTab>
|
|
107
|
+
</TerminalTabs>
|
|
108
|
+
|
|
109
|
+
> **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`.
|
|
110
|
+
|
|
111
|
+
```typescript title="src/index.tsx"
|
|
112
|
+
const config = {
|
|
113
|
+
// ...
|
|
114
|
+
baseURL: '/assets'
|
|
115
|
+
// ...
|
|
116
|
+
};
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Step 4: Run the Development Server
|
|
120
|
+
|
|
121
|
+
<TerminalTabs syncKey="package-manager">
|
|
122
|
+
<TerminalTab label="npm">
|
|
123
|
+
npm run dev
|
|
124
|
+
</TerminalTab>
|
|
125
|
+
|
|
126
|
+
<TerminalTab label="pnpm">
|
|
127
|
+
pnpm run dev
|
|
128
|
+
</TerminalTab>
|
|
129
|
+
|
|
130
|
+
<TerminalTab label="yarn">
|
|
131
|
+
yarn dev
|
|
132
|
+
</TerminalTab>
|
|
133
|
+
</TerminalTabs>
|
|
134
|
+
|
|
135
|
+
Open `http://localhost:5173` in your browser.
|
|
136
|
+
|
|
137
|
+
</TabItem>
|
|
138
|
+
|
|
139
|
+
<TabItem label="Existing Project">
|
|
140
|
+
## Get Started
|
|
141
|
+
|
|
142
|
+
Integrate the Automated Video Generation editor into an existing React application. This adds the editor configuration to your current project structure.
|
|
143
|
+
|
|
144
|
+
## Step 1: Clone
|
|
145
|
+
|
|
146
|
+
<TerminalTabs>
|
|
147
|
+
<TerminalTab label="Navigate">
|
|
148
|
+
cd your-project
|
|
149
|
+
</TerminalTab>
|
|
150
|
+
</TerminalTabs>
|
|
151
|
+
|
|
152
|
+
Clone the starter kit and copy the editor configuration to your project:
|
|
153
|
+
|
|
154
|
+
<TerminalTabs>
|
|
155
|
+
<TerminalTab label="git">
|
|
156
|
+
git clone https://github.com/imgly/starterkit-video-placeholders-react-web.git
|
|
157
|
+
cp -r starterkit-video-placeholders-react-web/src/imgly ./src/imgly
|
|
158
|
+
rm -rf starterkit-video-placeholders-react-web
|
|
159
|
+
</TerminalTab>
|
|
160
|
+
|
|
161
|
+
<TerminalTab label="degit">
|
|
162
|
+
npx degit imgly/starterkit-video-placeholders-react-web/src/imgly ./src/imgly
|
|
163
|
+
</TerminalTab>
|
|
164
|
+
</TerminalTabs>
|
|
165
|
+
|
|
166
|
+
> **Adjust Path:** The default destination is `./src/imgly`. Adjust the path to match your project structure.
|
|
167
|
+
|
|
168
|
+
The `imgly/` folder contains the editor configuration:
|
|
169
|
+
|
|
170
|
+
```
|
|
171
|
+
imgly/
|
|
172
|
+
├── config/
|
|
173
|
+
│ ├── advanced-video-editor/
|
|
174
|
+
│ │ ├── actions.ts # Export/import actions
|
|
175
|
+
│ │ ├── features.ts # Feature toggles
|
|
176
|
+
│ │ ├── i18n.ts # Translations
|
|
177
|
+
│ │ ├── plugin.ts # Main configuration plugin
|
|
178
|
+
│ │ ├── settings.ts # Engine settings
|
|
179
|
+
│ │ └── ui/
|
|
180
|
+
│ │ ├── canvas.ts # Canvas configuration
|
|
181
|
+
│ │ ├── components.ts # Custom component registration
|
|
182
|
+
│ │ ├── dock.ts # Dock layout configuration
|
|
183
|
+
│ │ ├── index.ts # Combines UI customization exports
|
|
184
|
+
│ │ ├── inspectorBar.ts # Inspector bar layout
|
|
185
|
+
│ │ ├── navigationBar.ts # Navigation bar layout
|
|
186
|
+
│ │ └── panel.ts # Panel configuration
|
|
187
|
+
│ └── video-editor/ # Same structure as advanced-video-editor/
|
|
188
|
+
└── index.ts # Editor initialization function
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Step 2: Install Dependencies
|
|
192
|
+
|
|
193
|
+
Install the required packages for the editor:
|
|
194
|
+
|
|
195
|
+
### Core Editor
|
|
196
|
+
|
|
197
|
+
Install the Creative Editor SDK:
|
|
198
|
+
|
|
199
|
+
<TerminalTabs syncKey="package-manager">
|
|
200
|
+
<TerminalTab label="npm">
|
|
201
|
+
npm install @cesdk/cesdk-js@$UBQ\_VERSION$ react react-dom
|
|
202
|
+
</TerminalTab>
|
|
203
|
+
|
|
204
|
+
<TerminalTab label="pnpm">
|
|
205
|
+
pnpm add @cesdk/cesdk-js@$UBQ\_VERSION$ react react-dom
|
|
206
|
+
</TerminalTab>
|
|
207
|
+
|
|
208
|
+
<TerminalTab label="yarn">
|
|
209
|
+
yarn add @cesdk/cesdk-js@$UBQ\_VERSION$ react react-dom
|
|
210
|
+
</TerminalTab>
|
|
211
|
+
</TerminalTabs>
|
|
212
|
+
|
|
213
|
+
## Step 3: Download Assets
|
|
214
|
+
|
|
215
|
+
CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project's `public/` directory.
|
|
216
|
+
|
|
217
|
+
<TerminalTabs>
|
|
218
|
+
<TerminalTab label="Download">
|
|
219
|
+
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/$UBQ\_VERSION$/imgly-assets.zip
|
|
220
|
+
unzip imgly-assets.zip -d public/
|
|
221
|
+
rm imgly-assets.zip
|
|
222
|
+
</TerminalTab>
|
|
223
|
+
</TerminalTabs>
|
|
224
|
+
|
|
225
|
+
> **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.
|
|
226
|
+
|
|
227
|
+
## Step 4: Add a Container Element
|
|
228
|
+
|
|
229
|
+
Add a container element to your HTML where the editor will be mounted:
|
|
230
|
+
|
|
231
|
+
```html
|
|
232
|
+
<div id="cesdk_container" style="width: 100%; height: 100vh;"></div>
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
## Step 5: Initialize the Editor
|
|
236
|
+
|
|
237
|
+
Choose your editing mode and initialize the editor accordingly:
|
|
238
|
+
|
|
239
|
+
<Tabs syncKey="editor-mode">
|
|
240
|
+
<TabItem label="Adopter">
|
|
241
|
+
```typescript title="src/index.ts"
|
|
242
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
243
|
+
|
|
244
|
+
import { initVideoPlaceholdersAdopterEditor } from './imgly';
|
|
245
|
+
|
|
246
|
+
const config = {
|
|
247
|
+
userId: 'your-user-id',
|
|
248
|
+
baseURL: '/assets'
|
|
249
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
250
|
+
};
|
|
251
|
+
|
|
252
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
253
|
+
.then(async (cesdk) => {
|
|
254
|
+
await initVideoPlaceholdersAdopterEditor(cesdk);
|
|
255
|
+
})
|
|
256
|
+
.catch((error) => {
|
|
257
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
258
|
+
});
|
|
259
|
+
```
|
|
260
|
+
</TabItem>
|
|
261
|
+
|
|
262
|
+
<TabItem label="Creator">
|
|
263
|
+
```typescript title="src/index.ts"
|
|
264
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
265
|
+
|
|
266
|
+
import { initVideoPlaceholdersCreatorEditor } from './imgly';
|
|
267
|
+
|
|
268
|
+
const config = {
|
|
269
|
+
userId: 'your-user-id',
|
|
270
|
+
baseURL: '/assets'
|
|
271
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
272
|
+
};
|
|
273
|
+
|
|
274
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
275
|
+
.then(async (cesdk) => {
|
|
276
|
+
await initVideoPlaceholdersCreatorEditor(cesdk);
|
|
277
|
+
})
|
|
278
|
+
.catch((error) => {
|
|
279
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
280
|
+
});
|
|
281
|
+
```
|
|
282
|
+
</TabItem>
|
|
283
|
+
</Tabs>
|
|
284
|
+
|
|
285
|
+
</TabItem>
|
|
286
|
+
|
|
287
|
+
<TabItem label="Creator">
|
|
288
|
+
```typescript title="src/index.tsx"
|
|
289
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
290
|
+
|
|
291
|
+
import { initVideoPlaceholdersCreatorEditor } from './imgly';
|
|
292
|
+
|
|
293
|
+
const config = {
|
|
294
|
+
userId: 'your-user-id',
|
|
295
|
+
baseURL: '/assets'
|
|
296
|
+
// license: 'YOUR_LICENSE_KEY',
|
|
297
|
+
};
|
|
298
|
+
|
|
299
|
+
CreativeEditorSDK.create('#cesdk_container', config)
|
|
300
|
+
.then(async (cesdk) => {
|
|
301
|
+
await initVideoPlaceholdersCreatorEditor(cesdk);
|
|
302
|
+
})
|
|
303
|
+
.catch((error) => {
|
|
304
|
+
console.error('Failed to initialize CE.SDK:', error);
|
|
305
|
+
});
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
</TabItem>
|
|
309
|
+
</Tabs>
|
|
310
|
+
|
|
311
|
+
## Video Placeholders
|
|
312
|
+
|
|
313
|
+
The Automated Video Generation starter kit uses a **Creator/Adopter workflow** for template-based video creation. This workflow separates template design from content filling, enabling scalable video production.
|
|
314
|
+
|
|
315
|
+
### Creator Mode
|
|
316
|
+
|
|
317
|
+
Creators design video templates with placeholder regions using the Advanced Video Editor configuration:
|
|
318
|
+
|
|
319
|
+
- **Full editing capabilities** with advanced timeline and inspector panel
|
|
320
|
+
- **Dark theme** optimized for professional editing workflows
|
|
321
|
+
- **Define placeholder regions** for video, image, and text content
|
|
322
|
+
- **Complete control** over template structure and design
|
|
323
|
+
|
|
324
|
+
```typescript title="src/imgly/index.ts"
|
|
325
|
+
export async function initVideoPlaceholdersCreatorEditor(
|
|
326
|
+
cesdk: CreativeEditorSDK
|
|
327
|
+
) {
|
|
328
|
+
// Use advanced video editor for full editing capabilities
|
|
329
|
+
await cesdk.addPlugin(new AdvancedVideoEditorConfig());
|
|
330
|
+
|
|
331
|
+
// Dark theme for professional editing
|
|
332
|
+
cesdk.ui.setTheme('dark');
|
|
333
|
+
|
|
334
|
+
// Enable placeholder features for template creation
|
|
335
|
+
cesdk.feature.enable('ly.img.placeholder*');
|
|
336
|
+
cesdk.feature.enable('ly.img.inspector');
|
|
337
|
+
|
|
338
|
+
// Set the Creator role
|
|
339
|
+
cesdk.engine.editor.setRole('Creator');
|
|
340
|
+
}
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Adopter Mode
|
|
344
|
+
|
|
345
|
+
Adopters customize templates by filling placeholders using the simplified Video Editor configuration:
|
|
346
|
+
|
|
347
|
+
- **Streamlined interface** focused on content replacement
|
|
348
|
+
- **Light theme** for content editing workflows
|
|
349
|
+
- **Replace placeholder content** while maintaining template structure
|
|
350
|
+
- **Limited editing** to preserve design consistency
|
|
351
|
+
|
|
352
|
+
```typescript title="src/imgly/index.ts"
|
|
353
|
+
export async function initVideoPlaceholdersAdopterEditor(
|
|
354
|
+
cesdk: CreativeEditorSDK
|
|
355
|
+
) {
|
|
356
|
+
// Use standard video editor for simplified experience
|
|
357
|
+
await cesdk.addPlugin(new VideoEditorConfig());
|
|
358
|
+
|
|
359
|
+
// Light theme for content editing
|
|
360
|
+
cesdk.ui.setTheme('light');
|
|
361
|
+
|
|
362
|
+
// Set the Adopter role
|
|
363
|
+
cesdk.engine.editor.setRole('Adopter');
|
|
364
|
+
}
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
> **Learn More About Placeholders:** See [Placeholders](./create-templates/add-dynamic-content/placeholders.md) for detailed documentation on creating and managing placeholder regions.
|
|
368
|
+
|
|
369
|
+
---
|
|
370
|
+
|
|
371
|
+
## Set Up a Scene
|
|
372
|
+
|
|
373
|
+
CE.SDK offers multiple ways to load content into the editor. Choose the method that matches your use case:
|
|
374
|
+
|
|
375
|
+
```typescript title="src/index.ts"
|
|
376
|
+
// Create a blank video canvas - starts with an empty video scene
|
|
377
|
+
await cesdk.actions.run('scene.create');
|
|
378
|
+
|
|
379
|
+
// Load from a template archive - restores a previously saved project
|
|
380
|
+
await cesdk.loadFromArchiveURL('https://example.com/template.zip');
|
|
381
|
+
|
|
382
|
+
// Load from a video URL - creates a new scene with the video
|
|
383
|
+
await cesdk.createFromVideo('https://example.com/video.mp4');
|
|
384
|
+
|
|
385
|
+
// Load from a scene file - restores a scene from JSON
|
|
386
|
+
await cesdk.loadFromURL('https://example.com/scene.json');
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
> **More Loading Options:** See [Open the Editor](./open-the-editor.md) for all available loading methods.
|
|
390
|
+
|
|
391
|
+
---
|
|
392
|
+
|
|
393
|
+
## Customize Assets
|
|
394
|
+
|
|
395
|
+
The 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.
|
|
396
|
+
|
|
397
|
+
Asset sources are added via plugins in `src/imgly/index.ts`. Enable or disable individual sources:
|
|
398
|
+
|
|
399
|
+
```typescript title="src/imgly/index.ts"
|
|
400
|
+
import {
|
|
401
|
+
FiltersAssetSource,
|
|
402
|
+
StickerAssetSource,
|
|
403
|
+
TextAssetSource,
|
|
404
|
+
VectorShapeAssetSource,
|
|
405
|
+
EffectsAssetSource
|
|
406
|
+
// ...
|
|
407
|
+
} from '@cesdk/cesdk-js/plugins';
|
|
408
|
+
|
|
409
|
+
// Add only the sources you need
|
|
410
|
+
await cesdk.addPlugin(new FiltersAssetSource());
|
|
411
|
+
await cesdk.addPlugin(new StickerAssetSource());
|
|
412
|
+
await cesdk.addPlugin(new TextAssetSource());
|
|
413
|
+
await cesdk.addPlugin(new VectorShapeAssetSource());
|
|
414
|
+
await cesdk.addPlugin(new EffectsAssetSource());
|
|
415
|
+
// ...
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
> **Available Asset Sources:** See [Asset Source Plugins](./plugins/asset-sources.md) for the complete list of available sources.
|
|
419
|
+
|
|
420
|
+
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.
|
|
421
|
+
|
|
422
|
+
## Configure Actions
|
|
423
|
+
|
|
424
|
+
Actions are functions that handle user interactions like exporting videos, saving scenes, and importing files. CE.SDK provides built-in actions that you can run directly or override with custom implementations.
|
|
425
|
+
|
|
426
|
+
**Key built-in actions:**
|
|
427
|
+
|
|
428
|
+
- `exportVideo` – Export the current video to MP4 or other formats
|
|
429
|
+
- `saveScene` – Save the scene as a JSON string for later editing
|
|
430
|
+
- `importScene` – Import a previously saved scene (supports `.scene` and `.cesdk` formats)
|
|
431
|
+
- `exportScene` – Export the scene as a JSON file or `.cesdk` archive with all assets
|
|
432
|
+
- `uploadFile` – Handle file uploads with progress tracking
|
|
433
|
+
|
|
434
|
+
Use `cesdk.actions.run()` to execute any action:
|
|
435
|
+
|
|
436
|
+
```typescript
|
|
437
|
+
// Run a built-in action
|
|
438
|
+
await cesdk.actions.run('exportVideo', { mimeType: 'video/mp4' });
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
#### Import from File Picker
|
|
442
|
+
|
|
443
|
+
```typescript title="src/imgly/config/actions.ts"
|
|
444
|
+
// Let users open videos from their device
|
|
445
|
+
cesdk.actions.register('importVideo', async () => {
|
|
446
|
+
const blobURL = await cesdk.utils.loadFile({
|
|
447
|
+
accept: 'video/*',
|
|
448
|
+
returnType: 'objectURL'
|
|
449
|
+
});
|
|
450
|
+
await cesdk.createFromVideo(blobURL);
|
|
451
|
+
});
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
#### Export and Save
|
|
455
|
+
|
|
456
|
+
```typescript title="src/imgly/config/actions.ts"
|
|
457
|
+
// Register export action that downloads the edited video
|
|
458
|
+
cesdk.actions.register('exportVideo', async (exportOptions) => {
|
|
459
|
+
const { blobs, options } = await cesdk.utils.export(exportOptions);
|
|
460
|
+
await cesdk.utils.downloadFile(blobs[0], options.mimeType);
|
|
461
|
+
});
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
> **Learn More:** See [Actions](./actions.md) for the full list of built-in actions, how to run them, and how to register custom actions.
|
|
465
|
+
|
|
466
|
+
---
|
|
467
|
+
|
|
468
|
+
## Customize (Optional)
|
|
469
|
+
|
|
470
|
+
### Theming
|
|
471
|
+
|
|
472
|
+
CE.SDK supports light and dark themes out of the box, plus automatic system preference detection. Switch between themes programmatically:
|
|
473
|
+
|
|
474
|
+
```typescript title="src/imgly/config/settings.ts"
|
|
475
|
+
// 'light' | 'dark' | 'system' | (() => 'light' | 'dark')
|
|
476
|
+
cesdk.ui.setTheme('dark');
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
See [Theming](./user-interface/appearance/theming.md) for custom color schemes, CSS variables, and advanced styling options.
|
|
480
|
+
|
|
481
|
+
### Localization
|
|
482
|
+
|
|
483
|
+
Customize UI labels and add support for multiple languages. The i18n system supports translation keys for all UI elements:
|
|
484
|
+
|
|
485
|
+
```typescript title="src/imgly/config/i18n.ts"
|
|
486
|
+
// Override specific labels
|
|
487
|
+
cesdk.i18n.setTranslations({
|
|
488
|
+
en: {
|
|
489
|
+
'actions.export.video': 'Download Video',
|
|
490
|
+
'common.cancel': 'Cancel',
|
|
491
|
+
'common.apply': 'Apply'
|
|
492
|
+
}
|
|
493
|
+
});
|
|
494
|
+
|
|
495
|
+
// Set the active locale
|
|
496
|
+
cesdk.i18n.setLocale('en');
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
See [Localization](./user-interface/localization.md) for supported languages, translation key reference, and right-to-left language support.
|
|
500
|
+
|
|
501
|
+
### UI Layout
|
|
502
|
+
|
|
503
|
+

|
|
504
|
+
|
|
505
|
+
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.
|
|
506
|
+
|
|
507
|
+
```typescript title="src/imgly/config/ui/navigationBar.ts"
|
|
508
|
+
// Get current navigation bar components
|
|
509
|
+
const navOrder = cesdk.ui.getNavigationBarOrder();
|
|
510
|
+
|
|
511
|
+
// Add a custom button to the navigation bar
|
|
512
|
+
cesdk.ui.insertNavigationBarOrderComponent(
|
|
513
|
+
'ly.img.spacer',
|
|
514
|
+
{ id: 'my-custom-action' },
|
|
515
|
+
'after'
|
|
516
|
+
);
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
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.
|
|
520
|
+
|
|
521
|
+
### Custom Components
|
|
522
|
+
|
|
523
|
+
Build custom UI components using the builder system and integrate them in the editor. Custom components receive reactive state updates and can interact with the engine API.
|
|
524
|
+
|
|
525
|
+
```typescript title="src/imgly/config/ui/components.ts"
|
|
526
|
+
// Register a custom component
|
|
527
|
+
cesdk.ui.registerComponent('my-custom-button', ({ builder, engine }) => {
|
|
528
|
+
const selectedBlocks = engine.block.findAllSelected();
|
|
529
|
+
|
|
530
|
+
builder.Button('apply-effect', {
|
|
531
|
+
label: 'Apply Effect',
|
|
532
|
+
isDisabled: selectedBlocks.length === 0,
|
|
533
|
+
onClick: () => {
|
|
534
|
+
// Apply custom logic to selected blocks
|
|
535
|
+
}
|
|
536
|
+
});
|
|
537
|
+
});
|
|
538
|
+
|
|
539
|
+
// Add the component to the navigation bar
|
|
540
|
+
cesdk.ui.insertNavigationBarOrderComponent(
|
|
541
|
+
'ly.img.spacer',
|
|
542
|
+
'my-custom-button',
|
|
543
|
+
'after'
|
|
544
|
+
);
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
Custom components automatically re-render when the engine state they depend on changes—no manual subscription management required.
|
|
548
|
+
|
|
549
|
+
See [Register New Component](./user-interface/ui-extensions/register-new-component.md) for the complete builder API and component patterns.
|
|
550
|
+
|
|
551
|
+
### Settings & Features
|
|
552
|
+
|
|
553
|
+
Fine-tune editor behavior through settings and features.
|
|
554
|
+
|
|
555
|
+
**Settings** configure core engine behavior—rendering, input handling, and history management:
|
|
556
|
+
|
|
557
|
+
```typescript title="src/imgly/config/settings.ts"
|
|
558
|
+
cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', true);
|
|
559
|
+
cesdk.engine.editor.setSettingBool('mouse/enableZoomControl', true);
|
|
560
|
+
cesdk.engine.editor.setSettingBool('features/undoHistory', true);
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
**Features** toggle which editing tools and panels appear in the UI:
|
|
564
|
+
|
|
565
|
+
```typescript title="src/imgly/config/features.ts"
|
|
566
|
+
// Toggle editor features
|
|
567
|
+
cesdk.feature.enable('ly.img.crop', true);
|
|
568
|
+
cesdk.feature.enable('ly.img.filter', true);
|
|
569
|
+
cesdk.feature.enable('ly.img.adjustment', true);
|
|
570
|
+
```
|
|
571
|
+
|
|
572
|
+
See [Settings](./settings.md) and [Features](./user-interface/customization/disable-or-enable.md) for the complete reference.
|
|
573
|
+
|
|
574
|
+
### Explore Plugins
|
|
575
|
+
|
|
576
|
+
CE.SDK has a rich plugin ecosystem that extends the editor with powerful capabilities. Plugins can add new features, integrate third-party services, or customize editor behavior.
|
|
577
|
+
|
|
578
|
+
#### Custom Asset Sources
|
|
579
|
+
|
|
580
|
+
Connect external asset libraries like Unsplash, Getty Images, or your own content management system. Asset sources let users browse and insert content from any source.
|
|
581
|
+
|
|
582
|
+
```typescript title="src/imgly/config/plugin.ts"
|
|
583
|
+
import UnsplashAssetSource from '@imgly/plugin-unsplash';
|
|
584
|
+
|
|
585
|
+
// Add Unsplash integration
|
|
586
|
+
await cesdk.addPlugin(
|
|
587
|
+
UnsplashAssetSource({
|
|
588
|
+
accessKey: 'your-unsplash-access-key'
|
|
589
|
+
})
|
|
590
|
+
);
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
See [Custom Asset Sources](./import-media/from-remote-source/unsplash.md) for integration patterns.
|
|
594
|
+
|
|
595
|
+
#### Discover More Plugins
|
|
596
|
+
|
|
597
|
+
Explore the full plugin ecosystem in the [IMG.LY plugins repository](https://github.com/imgly/plugins). Available plugins include:
|
|
598
|
+
|
|
599
|
+
- **Vectorizer** – Convert raster images to vectors
|
|
600
|
+
- **AI Integration** – Text-to-image generation and enhancement
|
|
601
|
+
- **And more** – Check the repository for the latest additions
|
|
602
|
+
|
|
603
|
+
---
|
|
604
|
+
|
|
605
|
+
## Key Capabilities
|
|
606
|
+
|
|
607
|
+
The Automated Video Generation starter kit enables template-based video creation at scale.
|
|
608
|
+
|
|
609
|
+
<CapabilityGrid
|
|
610
|
+
features={[
|
|
611
|
+
{
|
|
612
|
+
title: 'Video Placeholders',
|
|
613
|
+
description:
|
|
614
|
+
'Define swappable video placeholder regions that users or scripts can customize with content.',
|
|
615
|
+
imageId: 'placeholders',
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
title: 'Text Placeholders',
|
|
619
|
+
description:
|
|
620
|
+
'Create editable text areas that maintain styling while allowing content changes.',
|
|
621
|
+
imageId: 'text-editing',
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
title: 'Creator/Adopter Workflow',
|
|
625
|
+
description:
|
|
626
|
+
'Separate template design from content filling with dedicated Creator and Adopter modes.',
|
|
627
|
+
imageId: 'templating',
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
title: 'Scalable Output',
|
|
631
|
+
description:
|
|
632
|
+
'Generate multiple video variations by swapping placeholder content programmatically.',
|
|
633
|
+
imageId: 'automation',
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
title: 'Video Export',
|
|
637
|
+
description:
|
|
638
|
+
'Export finished videos in MP4 format with customizable quality settings.',
|
|
639
|
+
imageId: 'client-side',
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
title: 'Media Library',
|
|
643
|
+
description:
|
|
644
|
+
'Access built-in media assets or integrate custom asset libraries.',
|
|
645
|
+
imageId: 'asset-libraries',
|
|
646
|
+
},
|
|
647
|
+
]}
|
|
648
|
+
/>
|
|
649
|
+
|
|
650
|
+
<br />
|
|
651
|
+
|
|
652
|
+
> **Free Trial:** [Sign up for a free trial](https://img.ly/forms/free-trial) to get a license key and remove the watermark.
|
|
653
|
+
|
|
654
|
+
---
|
|
655
|
+
|
|
656
|
+
## Troubleshooting
|
|
657
|
+
|
|
658
|
+
### Editor doesn't load
|
|
659
|
+
|
|
660
|
+
- **Check the container element exists**: Ensure your container element is in the DOM before calling `create()`
|
|
661
|
+
- **Verify the baseURL**: Assets must be accessible from the CDN or your self-hosted location
|
|
662
|
+
- **Check console errors**: Look for CORS or network errors in browser developer tools
|
|
663
|
+
|
|
664
|
+
### Video playback issues
|
|
665
|
+
|
|
666
|
+
- **Check video format**: Ensure video files are in supported formats (MP4, WebM)
|
|
667
|
+
- **Browser compatibility**: Some codecs may not be supported in all browsers
|
|
668
|
+
|
|
669
|
+
### Watermark appears in production
|
|
670
|
+
|
|
671
|
+
- **Add your license key**: Set the `license` property in your configuration
|
|
672
|
+
- **Sign up for a trial**: Get a free trial license at [img.ly/forms/free-trial](https://img.ly/forms/free-trial)
|
|
673
|
+
|
|
674
|
+
---
|
|
675
|
+
|
|
676
|
+
## Next Steps
|
|
677
|
+
|
|
678
|
+
- [Configuration](./configuration.md) – Complete list of initialization options
|
|
679
|
+
- [Serve Assets](./serve-assets.md) – Self-host engine assets for production
|
|
680
|
+
- [Actions](./actions.md) – Build custom export and save workflows
|
|
681
|
+
- [Theming](./user-interface/appearance/theming.md) – Customize colors and appearance
|
|
682
|
+
- [Localization](./user-interface/localization.md) – Add translations and language support
|
|
683
|
+
- [Placeholders](./create-templates/add-dynamic-content/placeholders.md) – Create and manage placeholder regions
|
|
684
|
+
|
|
685
|
+
---
|
|
686
|
+
|
|
687
|
+
## More Resources
|
|
688
|
+
|
|
689
|
+
- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
|
|
690
|
+
- **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
|
|
691
|
+
- **[Web Documentation](./js.md)** - Interactive documentation with examples
|
|
692
|
+
- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
|