@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,110 @@
|
|
|
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:** [Upgrading](./upgrade.md) > [To v1.32](./to-v1-32.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Version v1.32 introduced powerful new APIs for customizing the CE.SDK web editor. These new APIs render some of the existing configurations obsolete, requiring code migration to leverage the more flexible new options.
|
|
8
|
+
|
|
9
|
+
This guide will help you navigate these changes and explain what you need to do to update your integration.
|
|
10
|
+
|
|
11
|
+
## Configuring the Dock
|
|
12
|
+
|
|
13
|
+
Until version 1.32, the dock was configured by two configuration options (although most users only used one of them and kept the others default):
|
|
14
|
+
|
|
15
|
+
- `config.ui.elements.libraries.insert.entries` and
|
|
16
|
+
- `config.ui.elements.dock`
|
|
17
|
+
|
|
18
|
+
If your configuration adapted one of these two (mostly `config.ui.elements.libraries.insert.entries`), you are affected by this change. For now, it is only deprecated and we will try to do an internal migration for you, but this still might include a breaking change depending on how you used the configuration options before.
|
|
19
|
+
|
|
20
|
+
### Breaking Change
|
|
21
|
+
|
|
22
|
+
`config.ui.elements.libraries.insert.entries` was called repeatedly with a context of currently selected blocks. Most users and configurations have not used this behavior and just returned the same static list of entries for every call. In this case, your configuration should work as before, but if you have relied on this fact, you have to migrate your configuration to the new API, listen to selection changes, and update the asset library entries accordingly.
|
|
23
|
+
|
|
24
|
+
### Migration to new APIs
|
|
25
|
+
|
|
26
|
+
Defining the dock is now done by our new APIs in a consistent way to all other customizable locations of the editor. With the [Dock API](./user-interface/customization/dock.md), you now have much greater control of how and what is displayed in the dock. This does not only include dock buttons to open asset libraries but also arbitrary buttons and other elements. Please take a look at the [Dock API](./user-interface/customization/dock.md) or learn about the general concept [here](./user-interface/overview.md).
|
|
27
|
+
|
|
28
|
+
If you aren't affected by the breaking change mentioned above, the easiest way to migrate is to first copy your current dock order after the editor has been inialized. This can be done by calling the new `cesdk.ui.getDockOrder()` method. Now you can take this order and set it during the initialization of the editor by using `cesdk.ui.setDockOrder(copiedDockOrder)`. The old configuration (`config.ui.elements.libraries.insert.entries` and `config.ui.elements.dock`) can be removed afterwards.
|
|
29
|
+
|
|
30
|
+
Of course, you could also just remove the old configuration and use the new API to define the dock order from scratch.
|
|
31
|
+
|
|
32
|
+
Please note, that changes to the asset library entries are now done by the [Asset Library Entry API](./import-media/asset-panel/basics.md) and the dock order is just referring to these. So if you, for instance, want to add an asset source id to be shown in a library, you have to add this asset source id to the asset library entry and not to the dock order.
|
|
33
|
+
|
|
34
|
+
```javascript
|
|
35
|
+
// Before
|
|
36
|
+
// ======
|
|
37
|
+
const config: Configuration = {
|
|
38
|
+
ui: {
|
|
39
|
+
elements: {
|
|
40
|
+
libraries: {
|
|
41
|
+
insert: {
|
|
42
|
+
entries: (defaultEntries) => {
|
|
43
|
+
return [
|
|
44
|
+
// Changing some of the default entries
|
|
45
|
+
...defaultEntries.map((entry) => {
|
|
46
|
+
if (entry.id === 'ly.img.image') {
|
|
47
|
+
entry.sourceIds.push('my-own-image-source');
|
|
48
|
+
}
|
|
49
|
+
return entry;
|
|
50
|
+
}),
|
|
51
|
+
// Adding a new entry
|
|
52
|
+
{
|
|
53
|
+
id: 'my-own-entry',
|
|
54
|
+
sourceIds: ['my-own-source']
|
|
55
|
+
}
|
|
56
|
+
];
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
// After
|
|
65
|
+
// ======
|
|
66
|
+
cesdk.ui.setDockOrder([
|
|
67
|
+
...cesdk.ui.getDockOrder(),
|
|
68
|
+
// Add a new button referencing your new entry
|
|
69
|
+
{
|
|
70
|
+
id: 'ly.img.assetLibrary.dock',
|
|
71
|
+
label: 'My Own Entry',
|
|
72
|
+
icon: [...],
|
|
73
|
+
entries: ['my-own-entry']
|
|
74
|
+
}
|
|
75
|
+
]);
|
|
76
|
+
|
|
77
|
+
// Adding your custom entry
|
|
78
|
+
cesdk.ui.addAssetLibraryEntry({
|
|
79
|
+
id: 'my-own-entry',
|
|
80
|
+
sourceIds: ['my-own-source']
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
// Updating an existing default entry
|
|
84
|
+
cesdk.ui.updateAssetLibraryEntry('ly.img.image', {
|
|
85
|
+
sourceIds: ({ currentIds }) => [...currentIds, 'my-own-image-source']
|
|
86
|
+
});
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Configuring the Asset Replacement Panel
|
|
90
|
+
|
|
91
|
+
Similar to the definition of the dock, we deprecate the configuration `config.ui.elements.libraries.replace.entries` of the asset library entries for the replacement panel. This method is deprecated but we will try to migrate your configuration internally until it is removed. We recommend you to migrate to the new API as soon as possible.
|
|
92
|
+
|
|
93
|
+
The new API is similar with subtle differences. With `cesdk.ui.setReplaceAssetLibraryEntries` you register a function that is called with the current context (of selected blocks) but only returns ids of entries.
|
|
94
|
+
|
|
95
|
+
### Breaking Change
|
|
96
|
+
|
|
97
|
+
With the `config.ui.elements.libraries.replace.entries` it was possible to take the default entries and modify them. In theory, you could change the entries and have different "default" entries for insert or replace. Now a change to a default entry provided by the editor via the [Asset Library Entry API](./import-media/asset-panel/basics.md) will be reflected in both the insert and replace entries. To solve this you can just copy one entry for replacement, modify it, and return its id instead.
|
|
98
|
+
|
|
99
|
+
### Migration to new APIs
|
|
100
|
+
|
|
101
|
+
Take the function from `config.ui.elements.libraries.replace.entries` and use it in `cesdk.ui.setReplaceAssetLibraryEntries` by replacing the entries with their ids. If you have made changes to the default entries or added new custom ones you need to add or change them via the [Asset Library Entry API](./import-media/asset-panel/basics.md) on initialization of the editor.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## More Resources
|
|
106
|
+
|
|
107
|
+
- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
|
|
108
|
+
- **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
|
|
109
|
+
- **[Web Documentation](./js.md)** - Interactive documentation with examples
|
|
110
|
+
- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
|
|
@@ -0,0 +1,468 @@
|
|
|
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:** [Upgrading](./upgrade.md) > [To v1.69](./to-v1-69.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Version 1.69 introduces Starter Kits, a new asset source plugin system, and consolidated asset naming conventions. This guide walks you through the breaking changes and migration steps.
|
|
8
|
+
|
|
9
|
+
## TL;DR
|
|
10
|
+
|
|
11
|
+
**Key changes:**
|
|
12
|
+
|
|
13
|
+
- Editor now initializes with a blank canvas by default
|
|
14
|
+
- `addDefaultAssetSources()` and `addDemoAssetSources()` are deprecated
|
|
15
|
+
- `createDesignScene()` and `createVideoScene()` are deprecated
|
|
16
|
+
- Asset source IDs have been renamed and consolidated (v5 naming)
|
|
17
|
+
- UI configuration options moved from `create()` to runtime APIs
|
|
18
|
+
- New plugin-based system for loading assets
|
|
19
|
+
- Unified `scene.create` action for scene creation
|
|
20
|
+
|
|
21
|
+
**Migration time:** ~15-30 minutes for most projects
|
|
22
|
+
|
|
23
|
+
## What's New in v1.69
|
|
24
|
+
|
|
25
|
+
### Starter Kits
|
|
26
|
+
|
|
27
|
+
Starter Kits are complete project templates with editable configuration files. Each kit provides a ready-to-run project with a well-defined architecture:
|
|
28
|
+
|
|
29
|
+
- A `config/` folder containing all editor configuration
|
|
30
|
+
- Separate files for UI layout, features, settings, and translations
|
|
31
|
+
- A configuration plugin class that wires everything together
|
|
32
|
+
- Clean separation between your app code and editor config
|
|
33
|
+
|
|
34
|
+
### Asset Restructuring
|
|
35
|
+
|
|
36
|
+
Version 1.69 introduces v5 assets and demo-v4 assets with updated naming conventions. This restructuring consolidates asset sources, establishes consistent naming patterns for asset source and asset IDs, and improves the developer experience when working with assets.
|
|
37
|
+
|
|
38
|
+
> **Self-Host Your Assets:** For production deployments, we recommend downloading the assets and hosting them on your own CDN. This ensures faster load times, better reliability, and full control over asset availability. You can download assets from our CDN and serve them from your infrastructure using the `baseURL` option in asset source plugins. See [Serve Assets](./serve-assets.md) for detailed instructions.
|
|
39
|
+
|
|
40
|
+
## Step-by-Step Migration
|
|
41
|
+
|
|
42
|
+
### Step 1: Adopt Starter Kit Configuration
|
|
43
|
+
|
|
44
|
+
Extract a Starter Kit config folder into your project:
|
|
45
|
+
|
|
46
|
+
<TerminalTabs>
|
|
47
|
+
<TerminalTab label="degit">
|
|
48
|
+
npx degit imgly/starterkit-design-editor-ts-web/src/imgly/config ./src/config
|
|
49
|
+
</TerminalTab>
|
|
50
|
+
|
|
51
|
+
<TerminalTab label="git">
|
|
52
|
+
git clone https://github.com/imgly/starterkit-design-editor-ts-web.git
|
|
53
|
+
cp -r starterkit-design-editor-ts-web/src/imgly/config ./src/config
|
|
54
|
+
rm -rf starterkit-design-editor-ts-web
|
|
55
|
+
</TerminalTab>
|
|
56
|
+
</TerminalTabs>
|
|
57
|
+
|
|
58
|
+
> **Adjust Path:** The default destination is `./src/config`. Adjust the path to match your project structure.
|
|
59
|
+
|
|
60
|
+
#### Which Starter Kit Should I Use?
|
|
61
|
+
|
|
62
|
+
Choose based on your previous editor setup:
|
|
63
|
+
|
|
64
|
+
- **Design Editor** — You used `createDesignScene()` for multi-page designs (social posts, flyers, presentations)
|
|
65
|
+
- **Video Editor** — You used `createVideoScene()` for video timeline editing
|
|
66
|
+
- **Advanced Design Editor** — You used `createDesignScene()` with the advanced inspector enabled to author design templates with placeholders for end-users to customize
|
|
67
|
+
- **Advanced Video Editor** — You used `createVideoScene()` with the advanced inspector enabled to author video templates with placeholders for end-users to customize
|
|
68
|
+
|
|
69
|
+
#### Available Starter Kits
|
|
70
|
+
|
|
71
|
+
| Starter Kit | Repository | Use Case |
|
|
72
|
+
| ---------------------- | ------------------------------------------------ | --------------------------- |
|
|
73
|
+
| Design Editor | `imgly/starterkit-design-editor-ts-web` | Multi-page design creation |
|
|
74
|
+
| Photo Editor | `imgly/starterkit-photo-editor-ts-web` | Single-image editing |
|
|
75
|
+
| Video Editor | `imgly/starterkit-video-editor-ts-web` | Video timeline editing |
|
|
76
|
+
| Advanced Design Editor | `imgly/starterkit-advanced-design-editor-ts-web` | Full-featured design editor |
|
|
77
|
+
| Advanced Video Editor | `imgly/starterkit-advanced-video-editor-ts-web` | Full-featured video editor |
|
|
78
|
+
| Design Viewer | `imgly/starterkit-design-viewer-ts-web` | Read-only design viewing |
|
|
79
|
+
| Video Player | `imgly/starterkit-video-player-ts-web` | Read-only video playback |
|
|
80
|
+
|
|
81
|
+
#### Repository Structure
|
|
82
|
+
|
|
83
|
+
The `config/` folder contains all configuration files you can modify:
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
config/
|
|
87
|
+
├── index.ts # Exports configuration class
|
|
88
|
+
├── plugin.ts # Main plugin class, orchestrates all setup
|
|
89
|
+
├── features.ts # Feature flags (text, stickers, audio, etc.)
|
|
90
|
+
├── settings.ts # Engine settings (page size, margins, etc.)
|
|
91
|
+
├── i18n.ts # Custom translations and labels
|
|
92
|
+
├── actions.ts # Export, save, and share button handlers
|
|
93
|
+
└── ui/
|
|
94
|
+
├── index.ts # UI setup entry point
|
|
95
|
+
├── canvas.ts # Canvas behavior (zoom, pan, selection)
|
|
96
|
+
├── components.ts # Custom UI components
|
|
97
|
+
├── dock.ts # Left dock panel order and items
|
|
98
|
+
├── inspectorBar.ts # Right inspector panel configuration
|
|
99
|
+
├── navigationBar.ts # Top navigation bar buttons
|
|
100
|
+
└── panel.ts # Panel settings and behavior
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Step 2: Use the Configuration Plugin
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
import CreativeEditorSDK from '@cesdk/cesdk-js';
|
|
107
|
+
import { DesignEditorConfig } from './config/plugin';
|
|
108
|
+
|
|
109
|
+
const cesdk = await CreativeEditorSDK.create('#editor', {
|
|
110
|
+
license: 'YOUR_CESDK_LICENSE_KEY',
|
|
111
|
+
baseURL: `https://cdn.img.ly/packages/imgly/cesdk-js/${CreativeEditorSDK.version}/assets`
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
// Add plugin first (resets configuration to clean slate)
|
|
115
|
+
await cesdk.addPlugin(new DesignEditorConfig());
|
|
116
|
+
|
|
117
|
+
// Apply custom configuration on top
|
|
118
|
+
// ...
|
|
119
|
+
|
|
120
|
+
// Create the scene
|
|
121
|
+
await cesdk.actions.run('scene.create');
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
> **Preserving Legacy Configuration:** If you're still using deprecated configuration options (like `callbacks`, `ui.elements`, `locale`, or `ui.colorLibraries` in the `create()` call), they continue to work. Starter Kits call `reapplyLegacyUserConfiguration()` at the end of their `initialize()` method to preserve your deprecated settings on top of their defaults, so you can adopt them incrementally. Once you've fully migrated to runtime APIs, you can safely remove this call.
|
|
125
|
+
|
|
126
|
+
### Step 3: Replace Deprecated Asset Loading Methods
|
|
127
|
+
|
|
128
|
+
Replace calls to `addDefaultAssetSources()` and `addDemoAssetSources()` with the new plugin-based approach.
|
|
129
|
+
|
|
130
|
+
#### Replacing `addDefaultAssetSources()`
|
|
131
|
+
|
|
132
|
+
**Before (deprecated):**
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
await cesdk.addDefaultAssetSources();
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
**After (v1.69+):**
|
|
139
|
+
|
|
140
|
+
The snippets below show the asset sources that `addDefaultAssetSources()` previously loaded by default. Include only the plugins your application requires:
|
|
141
|
+
|
|
142
|
+
<Tabs syncKey="editor-type">
|
|
143
|
+
<TabItem label="Design">
|
|
144
|
+
```ts
|
|
145
|
+
import {
|
|
146
|
+
BlurAssetSource,
|
|
147
|
+
ColorPaletteAssetSource,
|
|
148
|
+
CropPresetsAssetSource,
|
|
149
|
+
EffectsAssetSource,
|
|
150
|
+
FiltersAssetSource,
|
|
151
|
+
PagePresetsAssetSource,
|
|
152
|
+
StickerAssetSource,
|
|
153
|
+
TextAssetSource,
|
|
154
|
+
TextComponentAssetSource,
|
|
155
|
+
TypefaceAssetSource,
|
|
156
|
+
VectorShapeAssetSource
|
|
157
|
+
} from '@cesdk/cesdk-js/plugins';
|
|
158
|
+
|
|
159
|
+
await cesdk.addPlugin(new ColorPaletteAssetSource());
|
|
160
|
+
await cesdk.addPlugin(new TypefaceAssetSource());
|
|
161
|
+
await cesdk.addPlugin(new TextAssetSource());
|
|
162
|
+
await cesdk.addPlugin(new TextComponentAssetSource());
|
|
163
|
+
await cesdk.addPlugin(new VectorShapeAssetSource());
|
|
164
|
+
await cesdk.addPlugin(new StickerAssetSource());
|
|
165
|
+
await cesdk.addPlugin(new EffectsAssetSource());
|
|
166
|
+
await cesdk.addPlugin(new FiltersAssetSource());
|
|
167
|
+
await cesdk.addPlugin(new BlurAssetSource());
|
|
168
|
+
await cesdk.addPlugin(new PagePresetsAssetSource());
|
|
169
|
+
await cesdk.addPlugin(new CropPresetsAssetSource());
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
</TabItem>
|
|
173
|
+
|
|
174
|
+
<TabItem label="Video">
|
|
175
|
+
```ts
|
|
176
|
+
import {
|
|
177
|
+
BlurAssetSource,
|
|
178
|
+
CaptionPresetsAssetSource,
|
|
179
|
+
ColorPaletteAssetSource,
|
|
180
|
+
CropPresetsAssetSource,
|
|
181
|
+
EffectsAssetSource,
|
|
182
|
+
FiltersAssetSource,
|
|
183
|
+
PagePresetsAssetSource,
|
|
184
|
+
StickerAssetSource,
|
|
185
|
+
TextAssetSource,
|
|
186
|
+
TextComponentAssetSource,
|
|
187
|
+
TypefaceAssetSource,
|
|
188
|
+
VectorShapeAssetSource
|
|
189
|
+
} from '@cesdk/cesdk-js/plugins';
|
|
190
|
+
|
|
191
|
+
await cesdk.addPlugin(new ColorPaletteAssetSource());
|
|
192
|
+
await cesdk.addPlugin(new TypefaceAssetSource());
|
|
193
|
+
await cesdk.addPlugin(new TextAssetSource());
|
|
194
|
+
await cesdk.addPlugin(new TextComponentAssetSource());
|
|
195
|
+
await cesdk.addPlugin(new VectorShapeAssetSource());
|
|
196
|
+
await cesdk.addPlugin(new StickerAssetSource());
|
|
197
|
+
await cesdk.addPlugin(new EffectsAssetSource());
|
|
198
|
+
await cesdk.addPlugin(new FiltersAssetSource());
|
|
199
|
+
await cesdk.addPlugin(new BlurAssetSource());
|
|
200
|
+
await cesdk.addPlugin(new CaptionPresetsAssetSource());
|
|
201
|
+
await cesdk.addPlugin(new PagePresetsAssetSource({
|
|
202
|
+
include: [
|
|
203
|
+
'ly.img.page.presets.facebook.*',
|
|
204
|
+
'ly.img.page.presets.instagram.*',
|
|
205
|
+
'ly.img.page.presets.linkedin.*',
|
|
206
|
+
'ly.img.page.presets.pinterest.*',
|
|
207
|
+
'ly.img.page.presets.tiktok.*',
|
|
208
|
+
'ly.img.page.presets.video.*',
|
|
209
|
+
'ly.img.page.presets.x.*',
|
|
210
|
+
'ly.img.page.presets.youtube.*'
|
|
211
|
+
]
|
|
212
|
+
}));
|
|
213
|
+
await cesdk.addPlugin(new CropPresetsAssetSource());
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
</TabItem>
|
|
217
|
+
</Tabs>
|
|
218
|
+
|
|
219
|
+
#### Replacing `addDemoAssetSources()`
|
|
220
|
+
|
|
221
|
+
**Before (deprecated):**
|
|
222
|
+
|
|
223
|
+
```ts
|
|
224
|
+
await cesdk.addDemoAssetSources();
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**After (v1.69+):**
|
|
228
|
+
|
|
229
|
+
The snippets below show the demo assets and upload sources that `addDemoAssetSources()` previously loaded by default. Include only the plugins your application requires:
|
|
230
|
+
|
|
231
|
+
<Tabs syncKey="editor-type">
|
|
232
|
+
<TabItem label="Design">
|
|
233
|
+
```ts
|
|
234
|
+
import { DemoAssetSources, UploadAssetSources } from '@cesdk/cesdk-js/plugins';
|
|
235
|
+
|
|
236
|
+
await cesdk.addPlugin(
|
|
237
|
+
new UploadAssetSources({
|
|
238
|
+
include: ['ly.img.image.upload']
|
|
239
|
+
})
|
|
240
|
+
);
|
|
241
|
+
await cesdk.addPlugin(
|
|
242
|
+
new DemoAssetSources({
|
|
243
|
+
include: [
|
|
244
|
+
'ly.img.image.*',
|
|
245
|
+
'ly.img.templates.blank.*',
|
|
246
|
+
'ly.img.templates.presentation.*',
|
|
247
|
+
'ly.img.templates.print.*',
|
|
248
|
+
'ly.img.templates.social.*'
|
|
249
|
+
]
|
|
250
|
+
})
|
|
251
|
+
);
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
</TabItem>
|
|
255
|
+
|
|
256
|
+
<TabItem label="Video">
|
|
257
|
+
```ts
|
|
258
|
+
import { DemoAssetSources, UploadAssetSources } from '@cesdk/cesdk-js/plugins';
|
|
259
|
+
|
|
260
|
+
await cesdk.addPlugin(
|
|
261
|
+
new UploadAssetSources({
|
|
262
|
+
include: ['ly.img.image.upload', 'ly.img.video.upload', 'ly.img.audio.upload']
|
|
263
|
+
})
|
|
264
|
+
);
|
|
265
|
+
await cesdk.addPlugin(
|
|
266
|
+
new DemoAssetSources({
|
|
267
|
+
include: [
|
|
268
|
+
'ly.img.audio.*',
|
|
269
|
+
'ly.img.image.*',
|
|
270
|
+
'ly.img.templates.video.*',
|
|
271
|
+
'ly.img.video.*'
|
|
272
|
+
]
|
|
273
|
+
})
|
|
274
|
+
);
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
</TabItem>
|
|
278
|
+
</Tabs>
|
|
279
|
+
|
|
280
|
+
#### Asset Source Plugins Reference
|
|
281
|
+
|
|
282
|
+
All plugins are imported from `@cesdk/cesdk-js/plugins`:
|
|
283
|
+
|
|
284
|
+
| Plugin | Asset Source ID | Description |
|
|
285
|
+
| --------------------------- | ------------------------ | ---------------------------- |
|
|
286
|
+
| `BlurAssetSource` | `ly.img.blur` | Blur effects |
|
|
287
|
+
| `CaptionPresetsAssetSource` | `ly.img.caption.presets` | Caption text presets (video) |
|
|
288
|
+
| `ColorPaletteAssetSource` | `ly.img.color.palette` | Color palettes |
|
|
289
|
+
| `CropPresetsAssetSource` | `ly.img.crop.presets` | Crop aspect ratios |
|
|
290
|
+
| `EffectsAssetSource` | `ly.img.effect` | Visual effects |
|
|
291
|
+
| `FiltersAssetSource` | `ly.img.filter` | LUT and duotone filters |
|
|
292
|
+
| `PagePresetsAssetSource` | `ly.img.page.presets` | Page size presets |
|
|
293
|
+
| `StickerAssetSource` | `ly.img.sticker` | Stickers and decorations |
|
|
294
|
+
| `TextAssetSource` | `ly.img.text` | Text presets |
|
|
295
|
+
| `TextComponentAssetSource` | `ly.img.text.components` | Styled text components |
|
|
296
|
+
| `TypefaceAssetSource` | `ly.img.typeface` | Fonts and typefaces |
|
|
297
|
+
| `VectorShapeAssetSource` | `ly.img.vector.shape` | Vector shapes |
|
|
298
|
+
| `UploadAssetSources` | `ly.img.*.upload` | User upload sources |
|
|
299
|
+
| `DemoAssetSources` | Various | Demo content for testing |
|
|
300
|
+
|
|
301
|
+
Each plugin accepts an optional configuration object with:
|
|
302
|
+
|
|
303
|
+
- `baseURL`: Custom base URL for loading assets
|
|
304
|
+
- `include`: GLOB patterns to filter which assets to load
|
|
305
|
+
- `assetLibraryEntries`: Map asset source IDs to UI library entry IDs
|
|
306
|
+
|
|
307
|
+
#### Demo Asset Sources
|
|
308
|
+
|
|
309
|
+
The `DemoAssetSources` plugin provides sample content for development and testing:
|
|
310
|
+
|
|
311
|
+
| Pattern | Description |
|
|
312
|
+
| --------------------------------- | ----------------------- |
|
|
313
|
+
| `ly.img.templates.*` | All template categories |
|
|
314
|
+
| `ly.img.templates.blank.*` | Blank templates |
|
|
315
|
+
| `ly.img.templates.social.*` | Social media templates |
|
|
316
|
+
| `ly.img.templates.print.*` | Print templates |
|
|
317
|
+
| `ly.img.templates.presentation.*` | Presentation templates |
|
|
318
|
+
| `ly.img.templates.video.*` | Video templates |
|
|
319
|
+
| `ly.img.image.*` | Demo images |
|
|
320
|
+
| `ly.img.video.*` | Demo videos |
|
|
321
|
+
| `ly.img.audio.*` | Demo audio |
|
|
322
|
+
|
|
323
|
+
> **Production vs. Development:** Use `DemoAssetSources` for development and testing. For production, replace demo assets with your own content or licensed stock assets.
|
|
324
|
+
|
|
325
|
+
#### Upload Asset Sources
|
|
326
|
+
|
|
327
|
+
The `UploadAssetSources` plugin enables file uploads:
|
|
328
|
+
|
|
329
|
+
| ID | Default MIME Types |
|
|
330
|
+
| --------------------- | ---------------------------------------------------------------------------------- |
|
|
331
|
+
| `ly.img.image.upload` | `image/jpeg`, `image/png`, `image/webp`, `image/svg+xml`, `image/bmp`, `image/gif` |
|
|
332
|
+
| `ly.img.video.upload` | `video/mp4`, `video/quicktime`, `video/webm`, `video/matroska`, `image/gif` |
|
|
333
|
+
| `ly.img.audio.upload` | `audio/mpeg`, `audio/mp3`, `audio/x-m4a`, `audio/wav` |
|
|
334
|
+
|
|
335
|
+
## Breaking Changes
|
|
336
|
+
|
|
337
|
+
### Asset Source ID Renames
|
|
338
|
+
|
|
339
|
+
The following asset source IDs have been renamed to align with v5 naming conventions:
|
|
340
|
+
|
|
341
|
+
| Old ID (deprecated) | New ID (v1.69+) |
|
|
342
|
+
| ------------------------------ | ------------------------ |
|
|
343
|
+
| `ly.img.captionPresets` | `ly.img.caption.presets` |
|
|
344
|
+
| `ly.img.colors.defaultPalette` | `ly.img.color.palette` |
|
|
345
|
+
| `ly.img.vectorpath` | `ly.img.vector.shape` |
|
|
346
|
+
| `ly.img.textComponents` | `ly.img.text.components` |
|
|
347
|
+
|
|
348
|
+
### Merged Asset Sources
|
|
349
|
+
|
|
350
|
+
The following asset sources have been consolidated:
|
|
351
|
+
|
|
352
|
+
| Old IDs (deprecated) | New ID (v1.69+) | Notes |
|
|
353
|
+
| --------------------------------------------------- | --------------------- | ----------------------------- |
|
|
354
|
+
| `ly.img.filter.lut` + `ly.img.filter.duotone` | `ly.img.filter` | Single source for all filters |
|
|
355
|
+
| `ly.img.page.presets` + `ly.img.page.presets.video` | `ly.img.page.presets` | Unified page presets |
|
|
356
|
+
| `ly.img.template` + `ly.img.video.template` | `ly.img.templates` | Unified template assets |
|
|
357
|
+
|
|
358
|
+
### Merged Feature API Identifiers
|
|
359
|
+
|
|
360
|
+
The following Feature API identifiers have been consolidated:
|
|
361
|
+
|
|
362
|
+
| Old IDs (deprecated) | New ID (v1.69+) | Notes |
|
|
363
|
+
| --------------------------------------------- | --------------- | ------------------------- |
|
|
364
|
+
| `ly.img.filter.lut` + `ly.img.filter.duotone` | `ly.img.filter` | Controls all filter types |
|
|
365
|
+
|
|
366
|
+
### Translation Key Updates
|
|
367
|
+
|
|
368
|
+
Translation keys have been updated to match the new asset source naming:
|
|
369
|
+
|
|
370
|
+
- Keys containing `captionPresets` → `caption.presets`
|
|
371
|
+
- Keys containing `colors.defaultPalette` → `color.palette`
|
|
372
|
+
- Keys containing `vectorpath` → `vector.shape`
|
|
373
|
+
- Keys containing `textComponents` → `text.components`
|
|
374
|
+
- Keys containing `filter.lut` or `filter.duotone` → `filter`
|
|
375
|
+
|
|
376
|
+
### Scene Creation Methods
|
|
377
|
+
|
|
378
|
+
The `createDesignScene()` and `createVideoScene()` methods are deprecated. Use the unified `scene.create` action instead.
|
|
379
|
+
|
|
380
|
+
<Tabs syncKey="editor-type">
|
|
381
|
+
<TabItem label="Design">
|
|
382
|
+
**Before (deprecated):**
|
|
383
|
+
|
|
384
|
+
```ts
|
|
385
|
+
await cesdk.createDesignScene();
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
**After (v1.69+):**
|
|
389
|
+
|
|
390
|
+
```ts
|
|
391
|
+
await cesdk.actions.run('scene.create');
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
</TabItem>
|
|
395
|
+
|
|
396
|
+
<TabItem label="Video">
|
|
397
|
+
**Before (deprecated):**
|
|
398
|
+
|
|
399
|
+
```ts
|
|
400
|
+
await cesdk.createVideoScene();
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
**After (v1.69+):**
|
|
404
|
+
|
|
405
|
+
```ts
|
|
406
|
+
await cesdk.actions.run('scene.create', { mode: 'Video' });
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
</TabItem>
|
|
410
|
+
</Tabs>
|
|
411
|
+
|
|
412
|
+
The new action provides a single entry point for scene creation with flexible configuration:
|
|
413
|
+
|
|
414
|
+
```ts
|
|
415
|
+
// Create a scene with specific page dimensions
|
|
416
|
+
await cesdk.actions.run('scene.create', {
|
|
417
|
+
page: { width: 1080, height: 1920, unit: 'Pixel' }
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
// Create a scene from a page preset asset
|
|
421
|
+
await cesdk.actions.run('scene.create', {
|
|
422
|
+
page: {
|
|
423
|
+
sourceId: 'ly.img.page.presets',
|
|
424
|
+
assetId: 'ly.img.page.presets.instagram.story'
|
|
425
|
+
}
|
|
426
|
+
});
|
|
427
|
+
|
|
428
|
+
// Create multiple pages at once
|
|
429
|
+
await cesdk.actions.run('scene.create', {
|
|
430
|
+
page: { width: 1080, height: 1080, unit: 'Pixel' },
|
|
431
|
+
pageCount: 3
|
|
432
|
+
});
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
> **Default Page Format Migration:** If you previously set `meta: { default: 'true' }` on a page preset asset to auto-select it when creating scenes, this is no longer applied automatically. Pass the desired page format explicitly via the `page` parameter.
|
|
436
|
+
|
|
437
|
+
```ts
|
|
438
|
+
await cesdk.actions.run('scene.create', {
|
|
439
|
+
page: {
|
|
440
|
+
sourceId: 'ly.img.page.presets',
|
|
441
|
+
assetId: 'ly.img.page.presets.instagram.story'
|
|
442
|
+
}
|
|
443
|
+
});
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
## Migration Checklist
|
|
447
|
+
|
|
448
|
+
Use this checklist to ensure a complete migration:
|
|
449
|
+
|
|
450
|
+
- Adopt a Starter Kit configuration for your editor type
|
|
451
|
+
- Replace `addDefaultAssetSources()` and `addDemoAssetSources()` calls with individual asset source plugins
|
|
452
|
+
- Update any hardcoded asset source IDs to use the new v5 naming conventions (see Breaking Changes)
|
|
453
|
+
- Test asset loading and UI configuration
|
|
454
|
+
|
|
455
|
+
## Want a Complete, Ready-to-Run App?
|
|
456
|
+
|
|
457
|
+
Extracting the configuration folder is ideal for existing projects where you need full control over editor setup. If you're starting fresh and want a complete application scaffold with build tooling, asset management, and framework integration already configured, explore our [Starter Kits](./starterkits.md) instead.
|
|
458
|
+
|
|
459
|
+
Starter Kits provide complete applications with everything wired together—clone, install, and start building.
|
|
460
|
+
|
|
461
|
+
---
|
|
462
|
+
|
|
463
|
+
## More Resources
|
|
464
|
+
|
|
465
|
+
- **[Vanilla JS/TS Documentation Index](https://img.ly/docs/cesdk/js.md)** - Browse all Vanilla JS/TS documentation
|
|
466
|
+
- **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
|
|
467
|
+
- **[Web Documentation](./js.md)** - Interactive documentation with examples
|
|
468
|
+
- **[Support](mailto:support@img.ly)** - Contact IMG.LY support
|