@imgly/codesign-mcp 0.1.8 → 0.1.9-next.20260720172141.gfa485d7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/README.md +36 -2
  2. package/assets/docs/api/SKILL.md +24 -22
  3. package/assets/docs/api/index.d.ts +129 -8
  4. package/assets/docs/guide/SKILL.md +4 -4
  5. package/assets/docs/guide/api/BlockAPI.md +77 -0
  6. package/assets/docs/guide/api/node/classes/blockapi.md +154 -0
  7. package/assets/docs/guide/api/node/interfaces/assetfacetvalue.md +23 -0
  8. package/assets/docs/guide/api/node/interfaces/assetquerydata.md +1 -0
  9. package/assets/docs/guide/api/node/interfaces/assetsqueryresult.md +1 -0
  10. package/assets/docs/guide/api/node/interfaces/configuration.md +1 -1
  11. package/assets/docs/guide/api/node/type-aliases/assetfacetpath.md +22 -0
  12. package/assets/docs/guide/api/node/type-aliases/assetpropertyfilter.md +3 -3
  13. package/assets/docs/guide/api/node/type-aliases/assetpropertypath.md +1 -2
  14. package/assets/docs/guide/api/node/type-aliases/boolpropertyname.md +2 -0
  15. package/assets/docs/guide/api/node/type-aliases/objecttypelonghand.md +2 -1
  16. package/assets/docs/guide/api/node/type-aliases/objecttypeshorthand.md +2 -1
  17. package/assets/docs/guide/api/node/type-aliases/transitiontype.md +24 -0
  18. package/assets/docs/guide/api/node/type-aliases/transitiontypelonghand.md +21 -0
  19. package/assets/docs/guide/api/node/type-aliases/transitiontypeshorthand.md +18 -0
  20. package/assets/docs/guide/api/node/variables/transition_types.md +21 -0
  21. package/assets/docs/guide/api/node.md +347 -0
  22. package/assets/docs/guide/api/types.md +1 -1
  23. package/assets/docs/guide/colors/apply.md +1 -1
  24. package/assets/docs/guide/colors/basics.md +1 -1
  25. package/assets/docs/guide/concepts/assets.md +69 -3
  26. package/assets/docs/guide/concepts/blocks.md +1 -1
  27. package/assets/docs/guide/concepts/error-catalog.md +1000 -0
  28. package/assets/docs/guide/concepts/terminology.md +1 -1
  29. package/assets/docs/guide/concepts.md +1 -0
  30. package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +1 -1
  31. package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +1 -1
  32. package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +1 -1
  33. package/assets/docs/guide/create-templates/add-dynamic-content.md +1 -1
  34. package/assets/docs/guide/{filters-and-effects/gradients.md → fills/gradient.md} +1 -1
  35. package/assets/docs/guide/fills.md +2 -2
  36. package/assets/docs/guide/get-started/agent-skills.md +74 -15
  37. package/assets/docs/guide/get-started/build-with-ai.md +9 -2
  38. package/assets/docs/guide/get-started/cesdk-plugin-coding-agents.md +101 -0
  39. package/assets/docs/guide/get-started/mcp-server.md +1 -1
  40. package/assets/docs/guide/get-started/overview.md +0 -1
  41. package/assets/docs/guide/import-media/default-assets.md +1 -1
  42. package/assets/docs/guide/llms-txt.md +1 -1
  43. package/assets/docs/guide/outlines/strokes.md +1 -1
  44. package/assets/docs/guide/text/edit.md +1 -0
  45. package/assets/docs/handbook/SKILL.md +111 -24
  46. package/dist/assets/inline.generated.d.ts.map +1 -1
  47. package/dist/assets/inline.generated.js +46 -37
  48. package/dist/assets/inline.generated.js.map +1 -1
  49. package/dist/cli/http.d.ts.map +1 -1
  50. package/dist/cli/http.js +8 -2
  51. package/dist/cli/http.js.map +1 -1
  52. package/dist/cli/stdio.d.ts.map +1 -1
  53. package/dist/cli/stdio.js +14 -2
  54. package/dist/cli/stdio.js.map +1 -1
  55. package/dist/cli/trial-license.generated.d.ts +1 -1
  56. package/dist/cli/trial-license.generated.js +1 -1
  57. package/dist/cli/trial-license.generated.js.map +1 -1
  58. package/dist/diagnostics/status.d.ts +1 -0
  59. package/dist/diagnostics/status.d.ts.map +1 -1
  60. package/dist/diagnostics/status.js +12 -0
  61. package/dist/diagnostics/status.js.map +1 -1
  62. package/dist/engine/engine-capacity.js +2 -2
  63. package/dist/engine/engine-capacity.js.map +1 -1
  64. package/dist/engine/engine-slots.d.ts.map +1 -1
  65. package/dist/engine/engine-slots.js +30 -16
  66. package/dist/engine/engine-slots.js.map +1 -1
  67. package/dist/features.d.ts +7 -0
  68. package/dist/features.d.ts.map +1 -0
  69. package/dist/features.js +45 -0
  70. package/dist/features.js.map +1 -0
  71. package/dist/frontmatter.d.ts +12 -0
  72. package/dist/frontmatter.d.ts.map +1 -0
  73. package/dist/frontmatter.js +42 -0
  74. package/dist/frontmatter.js.map +1 -0
  75. package/dist/gateway/local.js +1 -1
  76. package/dist/gateway/local.js.map +1 -1
  77. package/dist/http/server.d.ts +0 -1
  78. package/dist/http/server.d.ts.map +1 -1
  79. package/dist/http/server.js +0 -1
  80. package/dist/http/server.js.map +1 -1
  81. package/dist/index.d.ts +1 -1
  82. package/dist/index.d.ts.map +1 -1
  83. package/dist/index.js.map +1 -1
  84. package/dist/server.d.ts +27 -4
  85. package/dist/server.d.ts.map +1 -1
  86. package/dist/server.js +72 -75
  87. package/dist/server.js.map +1 -1
  88. package/dist/skill-prompts.d.ts +3 -0
  89. package/dist/skill-prompts.d.ts.map +1 -0
  90. package/dist/skill-prompts.js +76 -0
  91. package/dist/skill-prompts.js.map +1 -0
  92. package/dist/skill-tool.d.ts +34 -0
  93. package/dist/skill-tool.d.ts.map +1 -0
  94. package/dist/skill-tool.js +207 -0
  95. package/dist/skill-tool.js.map +1 -0
  96. package/dist/tools/edit.d.ts.map +1 -1
  97. package/dist/tools/edit.js +21 -4
  98. package/dist/tools/edit.js.map +1 -1
  99. package/dist/tools/engine.d.ts +23 -13
  100. package/dist/tools/engine.d.ts.map +1 -1
  101. package/dist/tools/engine.js +45 -34
  102. package/dist/tools/engine.js.map +1 -1
  103. package/dist/tools/export.d.ts +7 -0
  104. package/dist/tools/export.d.ts.map +1 -1
  105. package/dist/tools/export.js +181 -42
  106. package/dist/tools/export.js.map +1 -1
  107. package/dist/tools/history.js +1 -1
  108. package/dist/tools/history.js.map +1 -1
  109. package/dist/tools/import.d.ts +2 -0
  110. package/dist/tools/import.d.ts.map +1 -1
  111. package/dist/tools/import.js +79 -24
  112. package/dist/tools/import.js.map +1 -1
  113. package/dist/tools/index.d.ts +6 -0
  114. package/dist/tools/index.d.ts.map +1 -1
  115. package/dist/tools/index.js +6 -3
  116. package/dist/tools/index.js.map +1 -1
  117. package/dist/tools/list.d.ts.map +1 -1
  118. package/dist/tools/list.js +8 -2
  119. package/dist/tools/list.js.map +1 -1
  120. package/dist/tools/media-sniff.d.ts +14 -0
  121. package/dist/tools/media-sniff.d.ts.map +1 -0
  122. package/dist/tools/media-sniff.js +80 -0
  123. package/dist/tools/media-sniff.js.map +1 -0
  124. package/dist/tools/preview.d.ts +2 -0
  125. package/dist/tools/preview.d.ts.map +1 -1
  126. package/dist/tools/preview.js +248 -51
  127. package/dist/tools/preview.js.map +1 -1
  128. package/dist/tools/save.d.ts.map +1 -1
  129. package/dist/tools/save.js +18 -1
  130. package/dist/tools/save.js.map +1 -1
  131. package/dist/tools/telemetry-wrapper.js +2 -2
  132. package/dist/tools/telemetry-wrapper.js.map +1 -1
  133. package/dist/viewer/cesdk-cdn.d.ts +21 -6
  134. package/dist/viewer/cesdk-cdn.d.ts.map +1 -1
  135. package/dist/viewer/cesdk-cdn.js +26 -7
  136. package/dist/viewer/cesdk-cdn.js.map +1 -1
  137. package/dist/viewer/router.d.ts.map +1 -1
  138. package/dist/viewer/router.js +3 -1
  139. package/dist/viewer/router.js.map +1 -1
  140. package/dist/viewer/spa-assets.generated.d.ts.map +1 -1
  141. package/dist/viewer/spa-assets.generated.js +16 -9
  142. package/dist/viewer/spa-assets.generated.js.map +1 -1
  143. package/package.json +4 -4
  144. package/dist/cross-ref.d.ts +0 -2
  145. package/dist/cross-ref.d.ts.map +0 -1
  146. package/dist/cross-ref.js +0 -31
  147. package/dist/cross-ref.js.map +0 -1
  148. package/dist/skill-tools.d.ts +0 -3
  149. package/dist/skill-tools.d.ts.map +0 -1
  150. package/dist/skill-tools.js +0 -105
  151. package/dist/skill-tools.js.map +0 -1
  152. /package/assets/docs/guide/{create-video → create-audio}/audio/adjust-speed.md +0 -0
  153. /package/assets/docs/guide/{create-video → create-audio}/audio/adjust-volume.md +0 -0
@@ -19,6 +19,7 @@ Defines a request for querying assets
19
19
  | `sortKey?` | `string` | The key that identifies the meta data value to sort by or 'id' to sort by the asset ID. If empty, the assets are sorted by the index. |
20
20
  | `sortActiveFirst?` | `boolean` | Sort assets that are marked as active first. |
21
21
  | `filter?` | [`AssetFilter`](./api/node/type-aliases/assetfilter.md)\[] | Optional structured filter, AND-combined with the result of `query` / `tags` / `groups` / `excludeGroups`. The top-level array is an implicit AND of its entries. Each entry is either a property predicate (`{ property, contains?, equals? }`) or a logical combinator (`{ and: [...] }`, `{ or: [...] }`, `{ not: ... }`). Combinators nest. **When to use `filter` vs `tags` / `groups` / `excludeGroups`:** The legacy `tags` / `groups` / `excludeGroups` fields remain supported and are equivalent to filter predicates with `equals` and implicit AND. Prefer `filter` for anything beyond a plain include/ exclude list — case-insensitive substrings, `meta.<key>` matches, `or` / `not` combinators — and reach for the legacy fields only when you want their case-sensitive exact-match semantics. Malformed filters reject the returned promise with the engine's parse-error message (e.g. `"Unknown asset property '…'"`). **Example** `filter: [ { property: 'label', contains: 'Roboto' }, { property: 'meta.languages', contains: 'de' }, { not: { property: 'meta.legacy', equals: 'true' } } ]` |
22
+ | `facets?` | [`AssetFacetPath`](./api/node/type-aliases/assetfacetpath.md)\[] | Facet distributions to compute over the matched (pre-pagination) set, e.g. to populate filter dropdowns. Local sources compute facets automatically; custom sources may fulfill any subset of the request. Combine with `perPage: 0` to enumerate values without fetching assets. |
22
23
 
23
24
 
24
25
  ---
@@ -18,6 +18,7 @@ Return type of a `findAssets` query.
18
18
  | `currentPage` | `number` | The current, requested page |
19
19
  | `nextPage?` | `number` | The next page to query if it exists |
20
20
  | `total` | `number` | How many assets are there in total for the current query regardless of the page |
21
+ | `facets?` | `object` | Distributions for the requested facet paths, keyed by the exact requested path string. Ordered by count descending, ties by value ascending. A missing key signals the source did not compute that facet. Absent entirely when no facets were requested or none were computed. |
21
22
 
22
23
 
23
24
  ---
@@ -23,7 +23,7 @@ and role.
23
23
  | ~~`presets`~~ | `object` | **Deprecated** This config key is not used anymore and will be removed. |
24
24
  | `presets.typefaces?` | `object` | **Deprecated** The configuration option `presets.typefaces` does not exist anymore. Custom typefaces should be defined as asset sources using the `cesdk.engine.asset.addSource` or `cesdk.engine.asset.addLocalSource` instead. |
25
25
  | `forceWebGL1?` | `boolean` | By default the engine tries to create a webgl2 context. If this fails it falls back to trying to create a webgl1 context. If this configuration option is set to true, it will no longer try to create a webgl2 context and always create a webgl1 context. |
26
- | `audioOutput?` | `"auto"` | `"none"` | Whether the engine should automatically choose an audio output device or should not output audio at all. If not configured the fallback value is 'auto'. |
26
+ | `audioOutput?` | `"none"` | `"auto"` | Whether the engine should automatically choose an audio output device or should not output audio at all. If not configured the fallback value is 'auto'. |
27
27
  | `role?` | [`RoleString`](./api/node/type-aliases/rolestring.md) | - |
28
28
 
29
29
 
@@ -0,0 +1,22 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ```ts
6
+ type AssetFacetPath = "tags" | "groups" | `meta.${string}`;
7
+ ```
8
+
9
+ Property paths that can be faceted — the facetable subset of
10
+ `AssetPropertyPath`. `label` and `id` are excluded because their
11
+ cardinality is unbounded.
12
+
13
+
14
+ ---
15
+
16
+ ## More Resources
17
+
18
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
19
+ - **[node API Reference](./api/node.md)** - Full node API reference
20
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
21
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
22
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -18,10 +18,10 @@ A single property predicate. Exactly one of `contains` (case-insensitive
18
18
  substring) or `equals` (case-insensitive equality) must be set — the
19
19
  type forbids passing both or neither. On a string-array property
20
20
  (`tags`, `groups`), the operator matches if any element matches.
21
+ `meta.<key>` values are flat strings, compared whole.
21
22
 
22
- `meta.<key>` values are flat strings in the engine; if a meta value
23
- was originally serialized as a number or boolean, stringify it the
24
- same way before comparing.
23
+ If a meta value was originally serialized as a number or boolean,
24
+ stringify it the same way before comparing.
25
25
 
26
26
  ## Type Declaration
27
27
 
@@ -7,8 +7,7 @@ type AssetPropertyPath = "label" | "tags" | "id" | "groups" | `meta.${string}`;
7
7
  ```
8
8
 
9
9
  Dot-path against the resolved asset that a property predicate targets:
10
- `label`, `id`, `tags`, `groups`, or `meta.<key>` (one segment — meta
11
- values in the engine are flat strings).
10
+ `label`, `id`, `tags`, `groups`, or `meta.<key>` (one segment).
12
11
 
13
12
  The template literal accepts `'meta.'` (empty key) because TypeScript's
14
13
  `${string}` includes the empty string; the engine rejects this at
@@ -40,6 +40,7 @@ type BoolPropertyName =
40
40
  | "text/clipLinesOutsideOfFrame"
41
41
  | "text/hasClippedLines"
42
42
  | "text/pathFlipped"
43
+ | "text/useContextualAlternates"
43
44
  | "text/useContextualLigatures"
44
45
  | "text/useDiscretionaryLigatures"
45
46
  | "text/useKerning"
@@ -49,6 +50,7 @@ type BoolPropertyName =
49
50
  | "caption/clipLinesOutsideOfFrame"
50
51
  | "caption/hasClippedLines"
51
52
  | "caption/pathFlipped"
53
+ | "caption/useContextualAlternates"
52
54
  | "caption/useContextualLigatures"
53
55
  | "caption/useDiscretionaryLigatures"
54
56
  | "caption/useKerning"
@@ -9,7 +9,8 @@ type ObjectTypeLonghand =
9
9
  | FillTypeLonghand
10
10
  | EffectTypeLonghand
11
11
  | BlurTypeLonghand
12
- | AnimationTypeLonghand;
12
+ | AnimationTypeLonghand
13
+ | TransitionTypeLonghand;
13
14
  ```
14
15
 
15
16
  The longhand block type IDs for all blocks types in the Creative Engine. Those are the Types returned by the
@@ -9,7 +9,8 @@ type ObjectTypeShorthand =
9
9
  | `fill/${FillTypeShorthand}`
10
10
  | `effect/${EffectTypeShorthand}`
11
11
  | `blur/${BlurTypeShorthand}`
12
- | `animation/${AnimationTypeShorthand}`;
12
+ | `animation/${AnimationTypeShorthand}`
13
+ | `transition/${TransitionTypeShorthand}`;
13
14
  ```
14
15
 
15
16
  The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be
@@ -0,0 +1,24 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ```ts
6
+ type TransitionType =
7
+ | TransitionTypeShorthand
8
+ | TransitionTypeLonghand;
9
+ ```
10
+
11
+ The block type IDs for the transition blocks. These are the IDs used to create new transitions
12
+ using `cesdk.engine.block.createTransition(id)`.
13
+ Refer to [TransitionTypeShorthand](./api/node/type-aliases/transitiontypeshorthand.md) and [TransitionTypeLonghand](./api/node/type-aliases/transitiontypelonghand.md) for more details.
14
+
15
+
16
+ ---
17
+
18
+ ## More Resources
19
+
20
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
21
+ - **[node API Reference](./api/node.md)** - Full node API reference
22
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
23
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
24
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -0,0 +1,21 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ```ts
6
+ type TransitionTypeLonghand = `//ly.img.ubq/transition/${TransitionTypeShorthand}`;
7
+ ```
8
+
9
+ The longhand block type IDs for the transition blocks. These are the IDs used to create new transitions
10
+ using `cesdk.engine.block.createTransition(id)`.
11
+
12
+
13
+ ---
14
+
15
+ ## More Resources
16
+
17
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
18
+ - **[node API Reference](./api/node.md)** - Full node API reference
19
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
20
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
21
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -0,0 +1,18 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ```ts
6
+ type TransitionTypeShorthand = typeof TRANSITION_TYPES[number];
7
+ ```
8
+
9
+
10
+ ---
11
+
12
+ ## More Resources
13
+
14
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
15
+ - **[node API Reference](./api/node.md)** - Full node API reference
16
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
17
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
18
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -0,0 +1,21 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ```ts
6
+ const TRANSITION_TYPES: readonly ["none", "cross-fade", "cross-blur", "cross-spin", "cross-zoom", "cross-warp", "push", "slide", "stack", "splice", "diagonal-splice", "fade", "fade-to-white", "fade-to-black", "color-wipe", "line-wipe", "wipe", "clock-wipe", "chop", "gradient-fade", "two-stripes"];
7
+ ```
8
+
9
+ The shorthand block type IDs for the transition blocks. These are the IDs used to create new transitions
10
+ using `cesdk.engine.block.createTransition(id)`.
11
+
12
+
13
+ ---
14
+
15
+ ## More Resources
16
+
17
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
18
+ - **[node API Reference](./api/node.md)** - Full node API reference
19
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
20
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
21
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -0,0 +1,347 @@
1
+ > This is one page of the CE.SDK Node.js `@cesdk/node` API reference. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md) or the [node API Index](./api/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
+
3
+ ---
4
+
5
+ ## Classes
6
+
7
+ | Class | Description |
8
+ | ------ | ------ |
9
+ | [AssetAPI](./api/node/classes/assetapi.md) | Manage asset sources and apply assets to scenes. |
10
+ | [BlockAPI](./api/node/classes/blockapi.md) | Create, manipulate, and query the building blocks of your design. |
11
+ | [CreativeEngine](./api/node/classes/creativeengine.md) | The CreativeEngine is the core processing unit of CE.SDK and handles state management, rendering, input handling, and much more. It provides APIs to directly interact with assets, blocks, scenes, and variables. These APIs can be used in a headless environment to build and manipulate designs programmatically, or in a browser to create interactive applications. |
12
+ | [EditorAPI](./api/node/classes/editorapi.md) | Control the design editor's behavior and settings. |
13
+ | [EngineActions](./api/node/classes/engineactions.md) | Named, overridable actions for one engine. Actions are either JS closures you register or engine defaults (e.g. undo/redo), and either kind can override the other by reusing the id. |
14
+ | [EventAPI](./api/node/classes/eventapi.md) | Subscribe to block lifecycle events in the design engine. |
15
+ | [SceneAPI](./api/node/classes/sceneapi.md) | Create, load, save, and manipulate scenes. |
16
+ | [VariableAPI](./api/node/classes/variableapi.md) | Manage text variables within design templates. |
17
+
18
+ ## Functions
19
+
20
+ | Function | Description |
21
+ | ------ | ------ |
22
+ | [isCMYKColor](./api/node/functions/iscmykcolor.md) | Type guard for [CMYKColor](./api/node/interfaces/cmykcolor.md). |
23
+ | [isRGBAColor](./api/node/functions/isrgbacolor.md) | Type guard for [RGBAColor](./api/node/interfaces/rgbacolor.md). |
24
+ | [isSpotColor](./api/node/functions/isspotcolor.md) | Type guard for [SpotColor](./api/node/interfaces/spotcolor.md). |
25
+
26
+ ## Type Aliases
27
+
28
+ | Type Alias | Description |
29
+ | ------ | ------ |
30
+ | [AddImageOptions](./api/node/type-aliases/addimageoptions.md) | Options for adding images to the scene. |
31
+ | [AnimationBaselineDirection](./api/node/type-aliases/animationbaselinedirection.md) | - |
32
+ | [AnimationBlockSwipeTextDirection](./api/node/type-aliases/animationblockswipetextdirection.md) | - |
33
+ | [AnimationEasing](./api/node/type-aliases/animationeasing.md) | - |
34
+ | [AnimationEntry](./api/node/type-aliases/animationentry.md) | Configuration options for animations. |
35
+ | [AnimationGrowDirection](./api/node/type-aliases/animationgrowdirection.md) | - |
36
+ | [AnimationJumpLoopDirection](./api/node/type-aliases/animationjumploopdirection.md) | - |
37
+ | [AnimationKenBurnsDirection](./api/node/type-aliases/animationkenburnsdirection.md) | - |
38
+ | [AnimationMergeTextDirection](./api/node/type-aliases/animationmergetextdirection.md) | - |
39
+ | [AnimationOptions](./api/node/type-aliases/animationoptions.md) | Options for configuring animations (in, loop, out animations). |
40
+ | [AnimationSpinDirection](./api/node/type-aliases/animationspindirection.md) | - |
41
+ | [AnimationSpinLoopDirection](./api/node/type-aliases/animationspinloopdirection.md) | - |
42
+ | [AnimationType](./api/node/type-aliases/animationtype.md) | The block type IDs for the animation blocks. These are the IDs used to create new animations using `cesdk.engine.block.createAnimation(id)`. Refer to [AnimationTypeShorthand](./api/node/type-aliases/animationtypeshorthand.md) and [AnimationTypeLonghand](./api/node/type-aliases/animationtypelonghand.md) for more details. |
43
+ | [AnimationTypeLonghand](./api/node/type-aliases/animationtypelonghand.md) | The longhand block type IDs for the animation blocks. These are the IDs used to create new animations using `cesdk.engine.block.createAnimation(id)`. |
44
+ | [AnimationTypeShorthand](./api/node/type-aliases/animationtypeshorthand.md) | - |
45
+ | [AnimationTypewriterTextWritingStyle](./api/node/type-aliases/animationtypewritertextwritingstyle.md) | - |
46
+ | [AnimationWipeDirection](./api/node/type-aliases/animationwipedirection.md) | - |
47
+ | [ApplicationMimeType](./api/node/type-aliases/applicationmimetype.md) | Represents the application MIME types used in the editor. |
48
+ | [AssetColor](./api/node/type-aliases/assetcolor.md) | Asset Color payload |
49
+ | [AssetFacetPath](./api/node/type-aliases/assetfacetpath.md) | Property paths that can be faceted — the facetable subset of `AssetPropertyPath`. `label` and `id` are excluded because their cardinality is unbounded. |
50
+ | [AssetFilter](./api/node/type-aliases/assetfilter.md) | Filter expression — predicate or logical combinator. Combinators nest arbitrarily. The union is mutually exclusive: an object with both `and` and `or`, or with `property` next to a combinator key, is rejected at the type level. |
51
+ | [AssetGroups](./api/node/type-aliases/assetgroups.md) | An asset can be member of multiple groups. Groups have a semantic meaning used to build and group UIs exploring the assets, e.g.sections in the content library, or for things like topics in Unsplash for instance. |
52
+ | [AssetMetaData](./api/node/type-aliases/assetmetadata.md) | Generic asset information |
53
+ | [AssetProperty](./api/node/type-aliases/assetproperty.md) | Asset property for payload |
54
+ | [AssetPropertyFilter](./api/node/type-aliases/assetpropertyfilter.md) | A single property predicate. Exactly one of `contains` (case-insensitive substring) or `equals` (case-insensitive equality) must be set — the type forbids passing both or neither. On a string-array property (`tags`, `groups`), the operator matches if any element matches. `meta.<key>` values are flat strings, compared whole. |
55
+ | [AssetPropertyPath](./api/node/type-aliases/assetpropertypath.md) | Dot-path against the resolved asset that a property predicate targets: `label`, `id`, `tags`, `groups`, or `meta.<key>` (one segment). |
56
+ | [AssetStylePresetAnimationProperties](./api/node/type-aliases/assetstylepresetanimationproperties.md) | The parameters of an [AssetStylePresetAnimation](./api/node/interfaces/assetstylepresetanimation.md): a map of the animation's property paths to values. The animation's `animation/*` properties (e.g. `animation/slide/fade`, `animation/grow/scaleFactor`) are value-checked and autocomplete, as are the animation controls (`playback/duration`, `animationEasing`, `textWritingStyle`, `textWritingOverlap`); any other property path is still accepted. These are animation paths, distinct from the block-property paths in [AssetStylePresetProperties](./api/node/type-aliases/assetstylepresetproperties.md). |
57
+ | [AssetStylePresetProperties](./api/node/type-aliases/assetstylepresetproperties.md) | The look of an [AssetStylePreset](./api/node/interfaces/assetstylepreset.md): a map of property paths to values. Known paths are value-checked and autocomplete (e.g. `stroke/enabled` must be a boolean, `stroke/width` a number, `fill/solid/color` a color); any other property path is still accepted with the broader [AssetStylePresetPropertyValue](./api/node/type-aliases/assetstylepresetpropertyvalue.md). Keys without a `/` are namespaced to the block (`text/` or `caption/`); keys with a `/` are used verbatim. |
58
+ | [AssetStylePresetPropertyValue](./api/node/type-aliases/assetstylepresetpropertyvalue.md) | A value a style preset can set on a property: a boolean, number, string (including enum values) or an RGB(A) color. Colors must be RGB(A) (`{ r, g, b, a? }`); CMYK and spot colors are not supported in presets. Structs and source sets cannot be set from a preset. A `null` value is ignored for regular properties; for the virtual `text/path` property it clears the baseline path. |
59
+ | [AssetStylePresetScalableProperty](./api/node/type-aliases/assetstylepresetscalableproperty.md) | A length property a style preset may scale with the block's font size (see [AssetStylePreset.scaleWithFontSize](./api/node/interfaces/assetstylepreset.md)). Restricted to the decoration lengths for which scaling is meaningful — stroke width, drop-shadow offset/blur and the caption background corner radius — not arbitrary numeric properties like `rotation` or `opacity`. |
60
+ | [AssetTransformPreset](./api/node/type-aliases/assettransformpreset.md) | Transform preset payload |
61
+ | [AsyncURIResolver](./api/node/type-aliases/asyncuriresolver.md) | An async-compatible URI resolver function. |
62
+ | [AudioExportOptions](./api/node/type-aliases/audioexportoptions.md) | Represents the options for exporting audio. |
63
+ | [AudioFromVideoOptions](./api/node/type-aliases/audiofromvideooptions.md) | Options for configuring audio extraction from video operations. |
64
+ | [AudioMimeType](./api/node/type-aliases/audiomimetype.md) | Represents the audio MIME types used in the editor. |
65
+ | [BlendMode](./api/node/type-aliases/blendmode.md) | - |
66
+ | [BlockEnumType](./api/node/type-aliases/blockenumtype.md) | - |
67
+ | [BlockState](./api/node/type-aliases/blockstate.md) | Represents the state of a design block. |
68
+ | [BlurType](./api/node/type-aliases/blurtype.md) | The block type IDs for the blur blocks. These are the IDs used to create new blurs using `cesdk.engine.block.createBlur(id)`. Refer to [BlurTypeShorthand](./api/node/type-aliases/blurtypeshorthand.md) and [BlurTypeLonghand](./api/node/type-aliases/blurtypelonghand.md) for more details. |
69
+ | [BlurTypeLonghand](./api/node/type-aliases/blurtypelonghand.md) | The longhand block type IDs for the blur blocks. These are the IDs used to create new blurs using `cesdk.engine.block.createBlur(id)`. |
70
+ | [BlurTypeShorthand](./api/node/type-aliases/blurtypeshorthand.md) | - |
71
+ | [BooleanOperation](./api/node/type-aliases/booleanoperation.md) | Represents the names of boolean operations. |
72
+ | [BoolPropertyName](./api/node/type-aliases/boolpropertyname.md) | - |
73
+ | [CameraClampingOvershootMode](./api/node/type-aliases/cameraclampingovershootmode.md) | - |
74
+ | [CaptionHorizontalAlignment](./api/node/type-aliases/captionhorizontalalignment.md) | - |
75
+ | [CaptionVerticalAlignment](./api/node/type-aliases/captionverticalalignment.md) | - |
76
+ | [CMYK](./api/node/type-aliases/cmyk.md) | Represents a color in the CMYK color space. |
77
+ | [Color](./api/node/type-aliases/color.md) | Represents all color types supported by the engine. |
78
+ | [ColorPickerColorMode](./api/node/type-aliases/colorpickercolormode.md) | - |
79
+ | [ColorPropertyName](./api/node/type-aliases/colorpropertyname.md) | - |
80
+ | [ColorSpace](./api/node/type-aliases/colorspace.md) | Represents the color space used in the editor. |
81
+ | [ContentFillMode](./api/node/type-aliases/contentfillmode.md) | - |
82
+ | [ControlGizmoMoveHandleVisibility](./api/node/type-aliases/controlgizmomovehandlevisibility.md) | - |
83
+ | [ControlGizmoResizeHandlesVisibility](./api/node/type-aliases/controlgizmoresizehandlesvisibility.md) | - |
84
+ | [ControlGizmoRotateHandlesVisibility](./api/node/type-aliases/controlgizmorotatehandlesvisibility.md) | - |
85
+ | [ControlGizmoScaleHandlesVisibility](./api/node/type-aliases/controlgizmoscalehandlesvisibility.md) | - |
86
+ | [CreateSceneOptions](./api/node/type-aliases/createsceneoptions.md) | Options for creating a video scene. |
87
+ | [CutoutOperation](./api/node/type-aliases/cutoutoperation.md) | Represents the type of a cutout. |
88
+ | [CutoutType](./api/node/type-aliases/cutouttype.md) | - |
89
+ | [~~DefaultAssetSourceId~~](./api/node/type-aliases/defaultassetsourceid.md) | Represents the default asset source IDs used in the editor. |
90
+ | [~~DemoAssetSourceId~~](./api/node/type-aliases/demoassetsourceid.md) | Represents the default demo asset source IDs used in the editor. |
91
+ | [DesignBlockId](./api/node/type-aliases/designblockid.md) | A numerical identifier for a design block |
92
+ | [DesignBlockType](./api/node/type-aliases/designblocktype.md) | The block type IDs for the top-level design blocks. These are the IDs used to create new blocks using `cesdk.engine.block.create(id)`. Refer to [DesignBlockTypeShorthand](./api/node/type-aliases/designblocktypeshorthand.md) and [DesignBlockTypeLonghand](./api/node/type-aliases/designblocktypelonghand.md) for more details. |
93
+ | [DesignBlockTypeLonghand](./api/node/type-aliases/designblocktypelonghand.md) | The longhand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using `cesdk.engine.block.create(id)`. |
94
+ | [DesignBlockTypeShorthand](./api/node/type-aliases/designblocktypeshorthand.md) | - |
95
+ | [DoubleClickSelectionMode](./api/node/type-aliases/doubleclickselectionmode.md) | - |
96
+ | [DoublePropertyName](./api/node/type-aliases/doublepropertyname.md) | - |
97
+ | [DropShadowOptions](./api/node/type-aliases/dropshadowoptions.md) | Options for configuring drop shadow effects on blocks. |
98
+ | [EditMode](./api/node/type-aliases/editmode.md) | Represents the current edit mode of the editor. |
99
+ | [EffectType](./api/node/type-aliases/effecttype.md) | The block type IDs for the effect blocks. These are the IDs used to create new effects using `cesdk.engine.block.createEffect(id)`. Refer to [EffectTypeShorthand](./api/node/type-aliases/effecttypeshorthand.md) and [EffectTypeLonghand](./api/node/type-aliases/effecttypelonghand.md) for more details. |
100
+ | [EffectTypeLonghand](./api/node/type-aliases/effecttypelonghand.md) | The longhand block type IDs for the effect blocks. These are the IDs used to create new effects using `cesdk.engine.block.createEffect(id)`. |
101
+ | [EffectTypeShorthand](./api/node/type-aliases/effecttypeshorthand.md) | - |
102
+ | [EngineActionId](./api/node/type-aliases/engineactionid.md) | Known action ids from [EngineActionsRegistry](./api/node/interfaces/engineactionsregistry.md). |
103
+ | [EngineCustomActionFunction](./api/node/type-aliases/enginecustomactionfunction.md) | A generic, untyped action function for custom ids. |
104
+ | [EnginePluginContext](./api/node/type-aliases/engineplugincontext.md) | Represents the context for an engine plugin. |
105
+ | [EnumPropertyName](./api/node/type-aliases/enumpropertyname.md) | - |
106
+ | [EnumValues](./api/node/type-aliases/enumvalues.md) | - |
107
+ | [ExportOptions](./api/node/type-aliases/exportoptions.md) | Represents the options for exporting a design block. |
108
+ | [FillPixelStreamOrientation](./api/node/type-aliases/fillpixelstreamorientation.md) | - |
109
+ | [FillType](./api/node/type-aliases/filltype.md) | The block type IDs for the fill blocks. These are the IDs used to create new fills using `cesdk.engine.block.createFill(id)`. Refer to [FillTypeShorthand](./api/node/type-aliases/filltypeshorthand.md) and [FillTypeLonghand](./api/node/type-aliases/filltypelonghand.md) for more details. |
110
+ | [FillTypeLonghand](./api/node/type-aliases/filltypelonghand.md) | The longhand block type IDs for the fill blocks. These are the IDs used to create new fills using `cesdk.engine.block.createFill(id)`. |
111
+ | [FillTypeShorthand](./api/node/type-aliases/filltypeshorthand.md) | - |
112
+ | [FloatPropertyName](./api/node/type-aliases/floatpropertyname.md) | - |
113
+ | [FontSizeUnit](./api/node/type-aliases/fontsizeunit.md) | Extended design unit type that includes Point for font size operations. Maintains consistency with SceneDesignUnit's capitalized naming convention. |
114
+ | [FontStyle](./api/node/type-aliases/fontstyle.md) | Allowed font styles. Mirrors the WASM `FontStyle` union. |
115
+ | [FontWeight](./api/node/type-aliases/fontweight.md) | Allowed font weights. Mirrors the `@cesdk/engine` (WASM) `FontWeight` union so a single `Font` is interchangeable across bindings. |
116
+ | [GradientstopRGBA](./api/node/type-aliases/gradientstoprgba.md) | Represents a gradient stop in the RGBA color space. |
117
+ | [HeightMode](./api/node/type-aliases/heightmode.md) | - |
118
+ | [HexColorString](./api/node/type-aliases/hexcolorstring.md) | Represents a hexadecimal color value (RGB or RGBA) that starts with a '#'. |
119
+ | [HistoryId](./api/node/type-aliases/historyid.md) | A numerical identifier for a history stack |
120
+ | [HistoryUpdate](./api/node/type-aliases/historyupdate.md) | Describes the kind of update that triggered an `onHistoryUpdatedWithKind` callback. |
121
+ | [HorizontalBlockAlignment](./api/node/type-aliases/horizontalblockalignment.md) | - |
122
+ | [HorizontalContentFillAlignment](./api/node/type-aliases/horizontalcontentfillalignment.md) | - |
123
+ | [ImageMimeType](./api/node/type-aliases/imagemimetype.md) | Represents the image MIME types used in the editor. |
124
+ | [IntPropertyName](./api/node/type-aliases/intpropertyname.md) | - |
125
+ | [ListStyle](./api/node/type-aliases/liststyle.md) | Represents the list style of a paragraph. |
126
+ | [Locale](./api/node/type-aliases/locale.md) | e.g. `en`, `de`, etc. |
127
+ | [LogLevel](./api/node/type-aliases/loglevel.md) | Provides logging functionality for the Creative Editor SDK. |
128
+ | [MimeType](./api/node/type-aliases/mimetype.md) | Represents the MIME types used in the editor. |
129
+ | [ObjectType](./api/node/type-aliases/objecttype.md) | The block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to `cesdk.engine.block.findByType(type)` for example. Refer to [ObjectTypeShorthand](./api/node/type-aliases/objecttypeshorthand.md) and [ObjectTypeLonghand](./api/node/type-aliases/objecttypelonghand.md) for more details. |
130
+ | [ObjectTypeLonghand](./api/node/type-aliases/objecttypelonghand.md) | The longhand block type IDs for all blocks types in the Creative Engine. Those are the Types returned by the engine when calling `cesdk.engine.block.getType(blockId)` for example. |
131
+ | [ObjectTypeShorthand](./api/node/type-aliases/objecttypeshorthand.md) | The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to `cesdk.engine.block.findByType(type)` for example. |
132
+ | [OptionalPrefix](./api/node/type-aliases/optionalprefix.md) | - |
133
+ | [PageGuidesSource](./api/node/type-aliases/pageguidessource.md) | - |
134
+ | [PaletteColor](./api/node/type-aliases/palettecolor.md) | Represents a color definition for the custom color palette. |
135
+ | [PositionMode](./api/node/type-aliases/positionmode.md) | - |
136
+ | [PositionXMode](./api/node/type-aliases/positionxmode.md) | - |
137
+ | [PositionYMode](./api/node/type-aliases/positionymode.md) | - |
138
+ | [PropertyType](./api/node/type-aliases/propertytype.md) | Represents the various types of properties that can be associated with design blocks. Each type corresponds to a different kind of data that can be used to define the properties of a design block within the system. |
139
+ | [RGBA](./api/node/type-aliases/rgba.md) | Represents a color in the RGBA color space. |
140
+ | [RoleString](./api/node/type-aliases/rolestring.md) | Represents a role string. |
141
+ | [DesignUnit](./api/node/type-aliases/designunit.md) | - |
142
+ | [SceneFontSizeUnit](./api/node/type-aliases/scenefontsizeunit.md) | - |
143
+ | [SceneLayout](./api/node/type-aliases/scenelayout.md) | - |
144
+ | [SceneMode](./api/node/type-aliases/scenemode.md) | - |
145
+ | [Scope](./api/node/type-aliases/scope.md) | Represents the various scopes that define the capabilities and permissions within the Creative Editor SDK. Each scope corresponds to a specific functionality or action that can be performed within the editor. |
146
+ | [SettingBoolPropertyName](./api/node/type-aliases/settingboolpropertyname.md) | - |
147
+ | [SettingColorPropertyName](./api/node/type-aliases/settingcolorpropertyname.md) | - |
148
+ | [SettingEnumPropertyName](./api/node/type-aliases/settingenumpropertyname.md) | - |
149
+ | [SettingEnumType](./api/node/type-aliases/settingenumtype.md) | - |
150
+ | [SettingEnumValues](./api/node/type-aliases/settingenumvalues.md) | - |
151
+ | [SettingFloatPropertyName](./api/node/type-aliases/settingfloatpropertyname.md) | - |
152
+ | [SettingIntPropertyName](./api/node/type-aliases/settingintpropertyname.md) | - |
153
+ | [SettingKey](./api/node/type-aliases/settingkey.md) | Union type of all valid setting keys. |
154
+ | [SettingsBool](./api/node/type-aliases/settingsbool.md) | - |
155
+ | [SettingsColor](./api/node/type-aliases/settingscolor.md) | Represents the color settings available in the editor. |
156
+ | [~~SettingsColorRGBA~~](./api/node/type-aliases/settingscolorrgba.md) | Represents the color settings available in the editor. |
157
+ | [SettingsEnum](./api/node/type-aliases/settingsenum.md) | - |
158
+ | [SettingsFloat](./api/node/type-aliases/settingsfloat.md) | - |
159
+ | [SettingsInt](./api/node/type-aliases/settingsint.md) | - |
160
+ | [SettingsString](./api/node/type-aliases/settingsstring.md) | - |
161
+ | [SettingStringPropertyName](./api/node/type-aliases/settingstringpropertyname.md) | - |
162
+ | [SettingType](./api/node/type-aliases/settingtype.md) | Represents the type of a setting. |
163
+ | [SettingValueType](./api/node/type-aliases/settingvaluetype.md) | Gets the value type for a specific setting key. |
164
+ | [ShapeType](./api/node/type-aliases/shapetype.md) | The block type IDs for the shape blocks. These are the IDs used to create new shapes using `cesdk.engine.block.createShape(id)`. Refer to [ShapeTypeShorthand](./api/node/type-aliases/shapetypeshorthand.md) and [ShapeTypeLonghand](./api/node/type-aliases/shapetypelonghand.md) for more details. |
165
+ | [ShapeTypeLonghand](./api/node/type-aliases/shapetypelonghand.md) | The longhand block type IDs for the blocks. These are the IDs used to create new shapes using `cesdk.engine.block.createShape(id)`. |
166
+ | [ShapeTypeShorthand](./api/node/type-aliases/shapetypeshorthand.md) | - |
167
+ | [ShapeVectorPathFillRule](./api/node/type-aliases/shapevectorpathfillrule.md) | - |
168
+ | [SizeMode](./api/node/type-aliases/sizemode.md) | - |
169
+ | [SortingOrder](./api/node/type-aliases/sortingorder.md) | The order to sort by if the asset source supports sorting. If set to None, the order is the same as the assets were added to the source. |
170
+ | [SourceSetPropertyName](./api/node/type-aliases/sourcesetpropertyname.md) | - |
171
+ | [SplitOptions](./api/node/type-aliases/splitoptions.md) | Options for configuring block split operations. |
172
+ | [StringPropertyName](./api/node/type-aliases/stringpropertyname.md) | - |
173
+ | [StrokeCap](./api/node/type-aliases/strokecap.md) | - |
174
+ | [StrokeCornerGeometry](./api/node/type-aliases/strokecornergeometry.md) | - |
175
+ | [StrokeDashEndCap](./api/node/type-aliases/strokedashendcap.md) | - |
176
+ | [StrokeDashStartCap](./api/node/type-aliases/strokedashstartcap.md) | - |
177
+ | [StrokeEndCap](./api/node/type-aliases/strokeendcap.md) | - |
178
+ | [StrokePosition](./api/node/type-aliases/strokeposition.md) | - |
179
+ | [StrokeStartCap](./api/node/type-aliases/strokestartcap.md) | - |
180
+ | [StrokeStyle](./api/node/type-aliases/strokestyle.md) | - |
181
+ | [SyncURIResolver](./api/node/type-aliases/syncuriresolver.md) | A synchronous URI resolver function. |
182
+ | [TextAnimationWritingStyle](./api/node/type-aliases/textanimationwritingstyle.md) | - |
183
+ | [TextCase](./api/node/type-aliases/textcase.md) | Represents the text case of a text block. |
184
+ | [TextDecorationLine](./api/node/type-aliases/textdecorationline.md) | Represents a line type for text decoration. |
185
+ | [TextDecorationStyle](./api/node/type-aliases/textdecorationstyle.md) | Represents the style of a text decoration line. |
186
+ | [HorizontalTextAlignment](./api/node/type-aliases/horizontaltextalignment.md) | - |
187
+ | [TextVerticalAlignment](./api/node/type-aliases/textverticalalignment.md) | - |
188
+ | [TimelineTrackVisibility](./api/node/type-aliases/timelinetrackvisibility.md) | - |
189
+ | [TouchPinchAction](./api/node/type-aliases/touchpinchaction.md) | - |
190
+ | [TouchRotateAction](./api/node/type-aliases/touchrotateaction.md) | - |
191
+ | [TransitionType](./api/node/type-aliases/transitiontype.md) | The block type IDs for the transition blocks. These are the IDs used to create new transitions using `cesdk.engine.block.createTransition(id)`. Refer to [TransitionTypeShorthand](./api/node/type-aliases/transitiontypeshorthand.md) and [TransitionTypeLonghand](./api/node/type-aliases/transitiontypelonghand.md) for more details. |
192
+ | [TransitionTypeLonghand](./api/node/type-aliases/transitiontypelonghand.md) | The longhand block type IDs for the transition blocks. These are the IDs used to create new transitions using `cesdk.engine.block.createTransition(id)`. |
193
+ | [TransitionTypeShorthand](./api/node/type-aliases/transitiontypeshorthand.md) | - |
194
+ | [~~TypefaceDefinition~~](./api/node/type-aliases/typefacedefinition.md) | Represents a typeface definition used in the editor. |
195
+ | [VerticalBlockAlignment](./api/node/type-aliases/verticalblockalignment.md) | - |
196
+ | [VerticalContentFillAlignment](./api/node/type-aliases/verticalcontentfillalignment.md) | - |
197
+ | [VideoExportOptions](./api/node/type-aliases/videoexportoptions.md) | Represents the options for exporting a video. |
198
+ | [VideoMimeType](./api/node/type-aliases/videomimetype.md) | Represents the video MIME types used in the editor. |
199
+ | [WidthMode](./api/node/type-aliases/widthmode.md) | - |
200
+ | [XYWH](./api/node/type-aliases/xywh.md) | Describes a rectangle on the screen. |
201
+ | [ZoomAutoFitAxis](./api/node/type-aliases/zoomautofitaxis.md) | The axis(es) for which to auto-fit. |
202
+ | [ZoomOptions](./api/node/type-aliases/zoomoptions.md) | Options for zooming to a block with optional animation. |
203
+
204
+ ## Enumerations
205
+
206
+ | Enumeration | Description |
207
+ | ------ | ------ |
208
+ | [CompressionFormat](./api/node/enumerations/compressionformat.md) | Compression format for scene serialization. |
209
+ | [CompressionLevel](./api/node/enumerations/compressionlevel.md) | Compression level for scene serialization. |
210
+
211
+ ## Interfaces
212
+
213
+ | Interface | Description |
214
+ | ------ | ------ |
215
+ | [AddVideoOptions](./api/node/interfaces/addvideooptions.md) | Options for adding videos to the scene. |
216
+ | [ApplyAssetOptions](./api/node/interfaces/applyassetoptions.md) | Options for applying an asset to the scene. |
217
+ | [Asset](./api/node/interfaces/asset.md) | Generic asset information |
218
+ | [AssetBooleanProperty](./api/node/interfaces/assetbooleanproperty.md) | Asset boolean property definition |
219
+ | [AssetCMYKColor](./api/node/interfaces/assetcmykcolor.md) | Asset Color payload CMYK representation |
220
+ | [AssetColorProperty](./api/node/interfaces/assetcolorproperty.md) | Asset color property definition |
221
+ | [AssetContentAspectRatio](./api/node/interfaces/assetcontentaspectratio.md) | Asset transform preset payload that snaps a block's frame to the intrinsic aspect ratio of the block's content (e.g. the underlying image or video). |
222
+ | [AssetDefinition](./api/node/interfaces/assetdefinition.md) | Definition of an asset used if an asset is added to an asset source. |
223
+ | [AssetEnumProperty](./api/node/interfaces/assetenumproperty.md) | Asset enum property definition |
224
+ | [AssetFacetValue](./api/node/interfaces/assetfacetvalue.md) | One bucket of a facet distribution. |
225
+ | [AssetFixedAspectRatio](./api/node/interfaces/assetfixedaspectratio.md) | Asset transform preset payload fixed aspect ratio |
226
+ | [AssetFixedSize](./api/node/interfaces/assetfixedsize.md) | Asset transform preset payload fixed size |
227
+ | [AssetFreeAspectRatio](./api/node/interfaces/assetfreeaspectratio.md) | Asset transform preset payload free aspect ratio |
228
+ | [AssetNumberProperty](./api/node/interfaces/assetnumberproperty.md) | Asset number property definition |
229
+ | [AssetPayload](./api/node/interfaces/assetpayload.md) | Asset payload |
230
+ | [AssetQueryData](./api/node/interfaces/assetquerydata.md) | Defines a request for querying assets |
231
+ | [AssetResult](./api/node/interfaces/assetresult.md) | Single asset result of a query from the engine. |
232
+ | [AssetRGBColor](./api/node/interfaces/assetrgbcolor.md) | Asset Color payload RGB representation |
233
+ | [AssetSource](./api/node/interfaces/assetsource.md) | A source of assets |
234
+ | [AssetSpotColor](./api/node/interfaces/assetspotcolor.md) | Asset Color payload SpotColor representation |
235
+ | [AssetsQueryResult](./api/node/interfaces/assetsqueryresult.md) | Return type of a `findAssets` query. |
236
+ | [AssetStringProperty](./api/node/interfaces/assetstringproperty.md) | Asset string property definition |
237
+ | [AssetStylePreset](./api/node/interfaces/assetstylepreset.md) | A declarative style preset the engine applies to text and caption blocks. The engine parses and applies it identically on every platform. Lives in [AssetPayload.stylePreset](./api/node/interfaces/assetpayload.md). |
238
+ | [AssetStylePresetAnimation](./api/node/interfaces/assetstylepresetanimation.md) | An animation slot of an [AssetStylePreset](./api/node/interfaces/assetstylepreset.md) (`inAnimation`, `outAnimation` or `loopAnimation`). |
239
+ | [AudioTrackInfo](./api/node/interfaces/audiotrackinfo.md) | Information about a single audio track from a video. This interface provides comprehensive metadata about audio tracks, including codec information, technical specifications, and track details. |
240
+ | [BlockEvent](./api/node/interfaces/blockevent.md) | Represents an event related to a design block. |
241
+ | [BlockStateError](./api/node/interfaces/blockstateerror.md) | Represents an error state for a design block. |
242
+ | [BlockStatePending](./api/node/interfaces/blockstatepending.md) | Represents a pending state for a design block. |
243
+ | [BlockStateReady](./api/node/interfaces/blockstateready.md) | Represents a ready state for a design block. |
244
+ | [Buffer](./api/node/interfaces/buffer.md) | Represents a buffer of data. |
245
+ | [CharacterInkBox](./api/node/interfaces/characterinkbox.md) | Tight ink-paint bounding box of a single grapheme, in global scene coordinates. Returned by `block.getTextCharacterInkBoxes`. The baseline Y is reported separately because it does not equal `y + height` (the box is the tight ink rect; the baseline anchors glyph descenders). |
246
+ | [CMYKColor](./api/node/interfaces/cmykcolor.md) | Represents a CMYK color value. |
247
+ | [CompleteAssetResult](./api/node/interfaces/completeassetresult.md) | Asset results that are returned from the engine. |
248
+ | [Configuration](./api/node/interfaces/configuration.md) | Specifies the configuration for the Creative Editor SDK. |
249
+ | [DominantColor](./api/node/interfaces/dominantcolor.md) | A single color extracted from the rendered appearance of a block. |
250
+ | [DominantColorsOptions](./api/node/interfaces/dominantcolorsoptions.md) | Options for `BlockAPI.getDominantColors`. |
251
+ | [EngineActionInfo](./api/node/interfaces/engineactioninfo.md) | Info about a registered action, from [EngineActions.list](./api/node/classes/engineactions.md). |
252
+ | [EngineActionsRegistry](./api/node/interfaces/engineactionsregistry.md) | Hook for hosts to add strongly-typed action ids. Augment via `declare module '@cesdk/engine'` to get autocomplete on register/run while still allowing custom string ids. |
253
+ | [EnginePlugin](./api/node/interfaces/engineplugin.md) | Represents an engine plugin. |
254
+ | [Font](./api/node/interfaces/font.md) | Individual font within a typeface. Field optionality matches `@cesdk/engine` (WASM) — fields not present in the engine response are simply omitted rather than empty strings. |
255
+ | [FontMetrics](./api/node/interfaces/fontmetrics.md) | Font metrics extracted from a font file. Values are in the font's design units coordinate space. |
256
+ | [GradientColorStop](./api/node/interfaces/gradientcolorstop.md) | Represents a gradient color stop. |
257
+ | [Logger](./api/node/interfaces/logger.md) | Represents a logger function. |
258
+ | [PageDuration](./api/node/interfaces/pageduration.md) | - |
259
+ | [Range](./api/node/interfaces/range.md) | An open range. |
260
+ | [RGBAColor](./api/node/interfaces/rgbacolor.md) | Represents an RGBA color value. |
261
+ | [RGBColor](./api/node/interfaces/rgbcolor.md) | Represents an RGB color value. |
262
+ | [Settings](./api/node/interfaces/settings.md) | Map of all available settings with their types. This provides type-safe access to all editor settings. |
263
+ | [Size2](./api/node/interfaces/size2.md) | - |
264
+ | [Source](./api/node/interfaces/source.md) | A single source width an intrinsic width & height. |
265
+ | [SpotColor](./api/node/interfaces/spotcolor.md) | Represents a spot color value. |
266
+ | [TextDecorationConfig](./api/node/interfaces/textdecorationconfig.md) | Configuration for text decorations on a text run. |
267
+ | [TextFontSizeOptions](./api/node/interfaces/textfontsizeoptions.md) | Options for text font size operations with unit support. |
268
+ | [TextRunInfo](./api/node/interfaces/textruninfo.md) | Represents a single contiguous text run with uniform formatting. |
269
+ | [TransientResource](./api/node/interfaces/transientresource.md) | Represents a transient resource. |
270
+ | [Typeface](./api/node/interfaces/typeface.md) | Typeface definition |
271
+ | [Vec2](./api/node/interfaces/vec2.md) | - |
272
+ | [Vec3](./api/node/interfaces/vec3.md) | - |
273
+
274
+ ## Variables
275
+
276
+ | Variable | Description |
277
+ | ------ | ------ |
278
+ | [ANIMATION\_TYPES](./api/node/variables/animation_types.md) | The shorthand block type IDs for the animation blocks. These are the IDs used to create new animations using `cesdk.engine.block.createAnimation(id)`. |
279
+ | [AnimationBaselineDirectionValues](./api/node/variables/animationbaselinedirectionvalues.md) | - |
280
+ | [AnimationBlockSwipeTextDirectionValues](./api/node/variables/animationblockswipetextdirectionvalues.md) | - |
281
+ | [AnimationEasingValues](./api/node/variables/animationeasingvalues.md) | - |
282
+ | [AnimationGrowDirectionValues](./api/node/variables/animationgrowdirectionvalues.md) | - |
283
+ | [AnimationJumpLoopDirectionValues](./api/node/variables/animationjumploopdirectionvalues.md) | - |
284
+ | [AnimationKenBurnsDirectionValues](./api/node/variables/animationkenburnsdirectionvalues.md) | - |
285
+ | [AnimationMergeTextDirectionValues](./api/node/variables/animationmergetextdirectionvalues.md) | - |
286
+ | [AnimationSpinDirectionValues](./api/node/variables/animationspindirectionvalues.md) | - |
287
+ | [AnimationSpinLoopDirectionValues](./api/node/variables/animationspinloopdirectionvalues.md) | - |
288
+ | [AnimationTypewriterTextWritingStyleValues](./api/node/variables/animationtypewritertextwritingstylevalues.md) | - |
289
+ | [AnimationWipeDirectionValues](./api/node/variables/animationwipedirectionvalues.md) | - |
290
+ | [BlendModeValues](./api/node/variables/blendmodevalues.md) | - |
291
+ | [BLUR\_TYPES](./api/node/variables/blur_types.md) | The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs using `cesdk.engine.block.createBlur(id)`. |
292
+ | [CameraClampingOvershootModeValues](./api/node/variables/cameraclampingovershootmodevalues.md) | - |
293
+ | [CaptionHorizontalAlignmentValues](./api/node/variables/captionhorizontalalignmentvalues.md) | - |
294
+ | [CaptionVerticalAlignmentValues](./api/node/variables/captionverticalalignmentvalues.md) | - |
295
+ | [ColorPickerColorModeValues](./api/node/variables/colorpickercolormodevalues.md) | - |
296
+ | [ContentFillModeValues](./api/node/variables/contentfillmodevalues.md) | - |
297
+ | [ControlGizmoMoveHandleVisibilityValues](./api/node/variables/controlgizmomovehandlevisibilityvalues.md) | - |
298
+ | [ControlGizmoResizeHandlesVisibilityValues](./api/node/variables/controlgizmoresizehandlesvisibilityvalues.md) | - |
299
+ | [ControlGizmoRotateHandlesVisibilityValues](./api/node/variables/controlgizmorotatehandlesvisibilityvalues.md) | - |
300
+ | [ControlGizmoScaleHandlesVisibilityValues](./api/node/variables/controlgizmoscalehandlesvisibilityvalues.md) | - |
301
+ | [CutoutTypeValues](./api/node/variables/cutouttypevalues.md) | - |
302
+ | [DESIGN\_BLOCK\_TYPES](./api/node/variables/design_block_types.md) | The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using `cesdk.engine.block.create(id)`. |
303
+ | [DoubleClickSelectionModeValues](./api/node/variables/doubleclickselectionmodevalues.md) | - |
304
+ | [EFFECT\_TYPES](./api/node/variables/effect_types.md) | The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects using `cesdk.engine.block.createEffect(id)`. |
305
+ | [FILL\_TYPES](./api/node/variables/fill_types.md) | The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills using `cesdk.engine.block.createFill(id)`. |
306
+ | [FillPixelStreamOrientationValues](./api/node/variables/fillpixelstreamorientationvalues.md) | - |
307
+ | [HeightModeValues](./api/node/variables/heightmodevalues.md) | - |
308
+ | [HorizontalContentFillAlignmentValues](./api/node/variables/horizontalcontentfillalignmentvalues.md) | - |
309
+ | [~~LogLevel~~](./api/node/variables/loglevel.md) | Provides a set of predefined log levels for the Creative Editor SDK. |
310
+ | [~~MimeType~~](./api/node/variables/mimetype.md) | Represents the MIME types used in the editor. |
311
+ | [PageGuidesSourceValues](./api/node/variables/pageguidessourcevalues.md) | - |
312
+ | [PositionXModeValues](./api/node/variables/positionxmodevalues.md) | - |
313
+ | [PositionYModeValues](./api/node/variables/positionymodevalues.md) | - |
314
+ | [SceneDesignUnitValues](./api/node/variables/scenedesignunitvalues.md) | - |
315
+ | [SceneFontSizeUnitValues](./api/node/variables/scenefontsizeunitvalues.md) | - |
316
+ | [SceneLayoutValues](./api/node/variables/scenelayoutvalues.md) | - |
317
+ | [SceneModeValues](./api/node/variables/scenemodevalues.md) | - |
318
+ | [SHAPE\_TYPES](./api/node/variables/shape_types.md) | The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes using `cesdk.engine.block.createShape(id)`. |
319
+ | [ShapeVectorPathFillRuleValues](./api/node/variables/shapevectorpathfillrulevalues.md) | - |
320
+ | [StrokeCapValues](./api/node/variables/strokecapvalues.md) | - |
321
+ | [StrokeCornerGeometryValues](./api/node/variables/strokecornergeometryvalues.md) | - |
322
+ | [StrokeDashEndCapValues](./api/node/variables/strokedashendcapvalues.md) | - |
323
+ | [StrokeDashStartCapValues](./api/node/variables/strokedashstartcapvalues.md) | - |
324
+ | [StrokeEndCapValues](./api/node/variables/strokeendcapvalues.md) | - |
325
+ | [StrokePositionValues](./api/node/variables/strokepositionvalues.md) | - |
326
+ | [StrokeStartCapValues](./api/node/variables/strokestartcapvalues.md) | - |
327
+ | [StrokeStyleValues](./api/node/variables/strokestylevalues.md) | - |
328
+ | [TextAnimationWritingStyleValues](./api/node/variables/textanimationwritingstylevalues.md) | - |
329
+ | [TextHorizontalAlignmentValues](./api/node/variables/texthorizontalalignmentvalues.md) | - |
330
+ | [TextVerticalAlignmentValues](./api/node/variables/textverticalalignmentvalues.md) | - |
331
+ | [TimelineTrackVisibilityValues](./api/node/variables/timelinetrackvisibilityvalues.md) | - |
332
+ | [TouchPinchActionValues](./api/node/variables/touchpinchactionvalues.md) | - |
333
+ | [TouchRotateActionValues](./api/node/variables/touchrotateactionvalues.md) | - |
334
+ | [TRANSITION\_TYPES](./api/node/variables/transition_types.md) | The shorthand block type IDs for the transition blocks. These are the IDs used to create new transitions using `cesdk.engine.block.createTransition(id)`. |
335
+ | [VerticalContentFillAlignmentValues](./api/node/variables/verticalcontentfillalignmentvalues.md) | - |
336
+ | [WidthModeValues](./api/node/variables/widthmodevalues.md) | - |
337
+
338
+
339
+ ---
340
+
341
+ ## More Resources
342
+
343
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
344
+ - **[node API Reference](./api/node.md)** - Full node API reference
345
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
346
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
347
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -20,7 +20,7 @@ Types: AudioTrackInfo
20
20
 
21
21
  ## blockTypes
22
22
 
23
- Types: DesignBlockTypeShorthand, DesignBlockTypeLonghand, DesignBlockType, ShapeTypeShorthand, ShapeTypeLonghand, ShapeType, FillTypeShorthand, FillTypeLonghand, FillType, EffectTypeShorthand, EffectTypeLonghand, EffectType, BlurTypeShorthand, BlurTypeLonghand, BlurType, AnimationTypeShorthand, AnimationTypeLonghand, AnimationType, ObjectTypeShorthand, ObjectTypeLonghand, ObjectType
23
+ Types: DesignBlockTypeShorthand, DesignBlockTypeLonghand, DesignBlockType, ShapeTypeShorthand, ShapeTypeLonghand, ShapeType, FillTypeShorthand, FillTypeLonghand, FillType, EffectTypeShorthand, EffectTypeLonghand, EffectType, BlurTypeShorthand, BlurTypeLonghand, BlurType, AnimationTypeShorthand, AnimationTypeLonghand, AnimationType, TransitionTypeShorthand, TransitionTypeLonghand, TransitionType, ObjectTypeShorthand, ObjectTypeLonghand, ObjectType
24
24
 
25
25
  ## canvas
26
26
 
@@ -1,6 +1,6 @@
1
1
  > This is one page of the CE.SDK Node.js documentation. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
2
 
3
- **Navigation:** [Guides](./guides.md) > [Colors](./colors.md) > [Apply Color](./colors/apply.md)
3
+ **Navigation:** [Guides](./guides.md) > [Colors](./colors.md) > [Apply Colors](./colors/apply.md)
4
4
 
5
5
  ---
6
6
 
@@ -1,6 +1,6 @@
1
1
  > This is one page of the CE.SDK Node.js documentation. For a complete overview, see the [Node.js Documentation Index](https://img.ly/docs/cesdk/node.md). For all docs in one file, see [llms-full.txt](./llms-full.txt.md).
2
2
 
3
- **Navigation:** [Guides](./guides.md) > [Colors](./colors.md) > [Basics](./colors/basics.md)
3
+ **Navigation:** [Guides](./guides.md) > [Colors](./colors.md) > [Color Basics](./colors/basics.md)
4
4
 
5
5
  ---
6
6