@imgly/codesign-mcp 0.1.7 → 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 (215) 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 +138 -11
  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/classes/creativeengine.md +13 -13
  8. package/assets/docs/guide/api/node/interfaces/assetfacetvalue.md +23 -0
  9. package/assets/docs/guide/api/node/interfaces/assetquerydata.md +1 -0
  10. package/assets/docs/guide/api/node/interfaces/assetsqueryresult.md +1 -0
  11. package/assets/docs/guide/api/node/interfaces/configuration.md +1 -1
  12. package/assets/docs/guide/api/node/type-aliases/assetfacetpath.md +22 -0
  13. package/assets/docs/guide/api/node/type-aliases/assetpropertyfilter.md +3 -3
  14. package/assets/docs/guide/api/node/type-aliases/assetpropertypath.md +1 -2
  15. package/assets/docs/guide/api/node/type-aliases/boolpropertyname.md +2 -0
  16. package/assets/docs/guide/api/node/type-aliases/objecttypelonghand.md +2 -1
  17. package/assets/docs/guide/api/node/type-aliases/objecttypeshorthand.md +2 -1
  18. package/assets/docs/guide/api/node/type-aliases/transitiontype.md +24 -0
  19. package/assets/docs/guide/api/node/type-aliases/transitiontypelonghand.md +21 -0
  20. package/assets/docs/guide/api/node/type-aliases/transitiontypeshorthand.md +18 -0
  21. package/assets/docs/guide/api/node/variables/transition_types.md +21 -0
  22. package/assets/docs/guide/api/node.md +347 -0
  23. package/assets/docs/guide/api/types.md +1 -1
  24. package/assets/docs/guide/colors/apply.md +1 -1
  25. package/assets/docs/guide/colors/basics.md +1 -1
  26. package/assets/docs/guide/concepts/assets.md +69 -3
  27. package/assets/docs/guide/concepts/blocks.md +1 -1
  28. package/assets/docs/guide/concepts/error-catalog.md +1000 -0
  29. package/assets/docs/guide/concepts/terminology.md +1 -1
  30. package/assets/docs/guide/concepts.md +1 -0
  31. package/assets/docs/guide/create-templates/add-dynamic-content/placeholders.md +1 -1
  32. package/assets/docs/guide/create-templates/add-dynamic-content/set-editing-constraints.md +1 -1
  33. package/assets/docs/guide/create-templates/add-dynamic-content/text-variables.md +1 -1
  34. package/assets/docs/guide/create-templates/add-dynamic-content.md +1 -1
  35. package/assets/docs/guide/edit-image/transform/scale.md +1 -3
  36. package/assets/docs/guide/{filters-and-effects/gradients.md → fills/gradient.md} +1 -1
  37. package/assets/docs/guide/fills.md +2 -2
  38. package/assets/docs/guide/filters-and-effects/duotone.md +1 -1
  39. package/assets/docs/guide/get-started/agent-skills.md +74 -15
  40. package/assets/docs/guide/get-started/build-with-ai.md +9 -2
  41. package/assets/docs/guide/get-started/bun.md +0 -2
  42. package/assets/docs/guide/get-started/cesdk-plugin-coding-agents.md +101 -0
  43. package/assets/docs/guide/get-started/deno.md +0 -1
  44. package/assets/docs/guide/get-started/mcp-server.md +1 -1
  45. package/assets/docs/guide/get-started/overview.md +0 -1
  46. package/assets/docs/guide/get-started/vanilla.md +0 -2
  47. package/assets/docs/guide/import-media/default-assets.md +21 -25
  48. package/assets/docs/guide/llms-txt.md +1 -1
  49. package/assets/docs/guide/outlines/strokes.md +1 -1
  50. package/assets/docs/guide/plugins/print-ready-pdf.md +0 -2
  51. package/assets/docs/guide/serve-assets.md +80 -23
  52. package/assets/docs/guide/text/edit.md +1 -0
  53. package/assets/docs/handbook/SKILL.md +116 -30
  54. package/dist/assets/inline.generated.d.ts.map +1 -1
  55. package/dist/assets/inline.generated.js +54 -45
  56. package/dist/assets/inline.generated.js.map +1 -1
  57. package/dist/cli/http.d.ts.map +1 -1
  58. package/dist/cli/http.js +25 -5
  59. package/dist/cli/http.js.map +1 -1
  60. package/dist/cli/stdio.d.ts.map +1 -1
  61. package/dist/cli/stdio.js +57 -16
  62. package/dist/cli/stdio.js.map +1 -1
  63. package/dist/cli/trial-license.generated.d.ts +1 -1
  64. package/dist/cli/trial-license.generated.js +1 -1
  65. package/dist/cli/trial-license.generated.js.map +1 -1
  66. package/dist/config.d.ts +6 -0
  67. package/dist/config.d.ts.map +1 -1
  68. package/dist/config.js +8 -0
  69. package/dist/config.js.map +1 -1
  70. package/dist/diagnostics/bundle.d.ts +3 -0
  71. package/dist/diagnostics/bundle.d.ts.map +1 -1
  72. package/dist/diagnostics/bundle.js +25 -22
  73. package/dist/diagnostics/bundle.js.map +1 -1
  74. package/dist/diagnostics/prompt.d.ts +3 -0
  75. package/dist/diagnostics/prompt.d.ts.map +1 -0
  76. package/dist/diagnostics/prompt.js +21 -0
  77. package/dist/diagnostics/prompt.js.map +1 -0
  78. package/dist/diagnostics/router.d.ts +12 -0
  79. package/dist/diagnostics/router.d.ts.map +1 -0
  80. package/dist/diagnostics/router.js +64 -0
  81. package/dist/diagnostics/router.js.map +1 -0
  82. package/dist/diagnostics/spa-assets.generated.d.ts +2 -0
  83. package/dist/diagnostics/spa-assets.generated.d.ts.map +1 -0
  84. package/dist/diagnostics/spa-assets.generated.js +1231 -0
  85. package/dist/diagnostics/spa-assets.generated.js.map +1 -0
  86. package/dist/diagnostics/status.d.ts +39 -0
  87. package/dist/diagnostics/status.d.ts.map +1 -0
  88. package/dist/diagnostics/status.js +65 -0
  89. package/dist/diagnostics/status.js.map +1 -0
  90. package/dist/diagnostics/summary.d.ts +48 -0
  91. package/dist/diagnostics/summary.d.ts.map +1 -0
  92. package/dist/diagnostics/summary.js +116 -0
  93. package/dist/diagnostics/summary.js.map +1 -0
  94. package/dist/diagnostics/tool.d.ts +16 -0
  95. package/dist/diagnostics/tool.d.ts.map +1 -0
  96. package/dist/diagnostics/tool.js +90 -0
  97. package/dist/diagnostics/tool.js.map +1 -0
  98. package/dist/engine/asset-sources.d.ts +8 -0
  99. package/dist/engine/asset-sources.d.ts.map +1 -1
  100. package/dist/engine/asset-sources.js +9 -2
  101. package/dist/engine/asset-sources.js.map +1 -1
  102. package/dist/engine/engine-capacity.js +2 -2
  103. package/dist/engine/engine-capacity.js.map +1 -1
  104. package/dist/engine/engine-slots.d.ts.map +1 -1
  105. package/dist/engine/engine-slots.js +30 -16
  106. package/dist/engine/engine-slots.js.map +1 -1
  107. package/dist/engine/uri-resolver.js.map +1 -1
  108. package/dist/features.d.ts +7 -0
  109. package/dist/features.d.ts.map +1 -0
  110. package/dist/features.js +45 -0
  111. package/dist/features.js.map +1 -0
  112. package/dist/frontmatter.d.ts +12 -0
  113. package/dist/frontmatter.d.ts.map +1 -0
  114. package/dist/frontmatter.js +42 -0
  115. package/dist/frontmatter.js.map +1 -0
  116. package/dist/gateway/local.js +1 -1
  117. package/dist/gateway/local.js.map +1 -1
  118. package/dist/http/server.d.ts +0 -1
  119. package/dist/http/server.d.ts.map +1 -1
  120. package/dist/http/server.js +0 -1
  121. package/dist/http/server.js.map +1 -1
  122. package/dist/index.d.ts +1 -1
  123. package/dist/index.d.ts.map +1 -1
  124. package/dist/index.js.map +1 -1
  125. package/dist/server.d.ts +51 -3
  126. package/dist/server.d.ts.map +1 -1
  127. package/dist/server.js +77 -60
  128. package/dist/server.js.map +1 -1
  129. package/dist/skill-prompts.d.ts +3 -0
  130. package/dist/skill-prompts.d.ts.map +1 -0
  131. package/dist/skill-prompts.js +76 -0
  132. package/dist/skill-prompts.js.map +1 -0
  133. package/dist/skill-tool.d.ts +34 -0
  134. package/dist/skill-tool.d.ts.map +1 -0
  135. package/dist/skill-tool.js +207 -0
  136. package/dist/skill-tool.js.map +1 -0
  137. package/dist/tools/edit.d.ts.map +1 -1
  138. package/dist/tools/edit.js +21 -4
  139. package/dist/tools/edit.js.map +1 -1
  140. package/dist/tools/engine.d.ts +89 -14
  141. package/dist/tools/engine.d.ts.map +1 -1
  142. package/dist/tools/engine.js +143 -33
  143. package/dist/tools/engine.js.map +1 -1
  144. package/dist/tools/export.d.ts +7 -0
  145. package/dist/tools/export.d.ts.map +1 -1
  146. package/dist/tools/export.js +201 -32
  147. package/dist/tools/export.js.map +1 -1
  148. package/dist/tools/history.js +1 -1
  149. package/dist/tools/history.js.map +1 -1
  150. package/dist/tools/import.d.ts +2 -0
  151. package/dist/tools/import.d.ts.map +1 -1
  152. package/dist/tools/import.js +79 -24
  153. package/dist/tools/import.js.map +1 -1
  154. package/dist/tools/index.d.ts +6 -0
  155. package/dist/tools/index.d.ts.map +1 -1
  156. package/dist/tools/index.js +8 -5
  157. package/dist/tools/index.js.map +1 -1
  158. package/dist/tools/list.d.ts.map +1 -1
  159. package/dist/tools/list.js +8 -2
  160. package/dist/tools/list.js.map +1 -1
  161. package/dist/tools/load.d.ts.map +1 -1
  162. package/dist/tools/load.js +26 -19
  163. package/dist/tools/load.js.map +1 -1
  164. package/dist/tools/media-sniff.d.ts +14 -0
  165. package/dist/tools/media-sniff.d.ts.map +1 -0
  166. package/dist/tools/media-sniff.js +80 -0
  167. package/dist/tools/media-sniff.js.map +1 -0
  168. package/dist/tools/preview.d.ts +2 -0
  169. package/dist/tools/preview.d.ts.map +1 -1
  170. package/dist/tools/preview.js +280 -63
  171. package/dist/tools/preview.js.map +1 -1
  172. package/dist/tools/save.d.ts.map +1 -1
  173. package/dist/tools/save.js +18 -1
  174. package/dist/tools/save.js.map +1 -1
  175. package/dist/tools/telemetry-wrapper.js +2 -2
  176. package/dist/tools/telemetry-wrapper.js.map +1 -1
  177. package/dist/tools/{open-editor.d.ts → view.d.ts} +3 -3
  178. package/dist/tools/view.d.ts.map +1 -0
  179. package/dist/tools/{open-editor.js → view.js} +20 -18
  180. package/dist/tools/view.js.map +1 -0
  181. package/dist/viewer/cesdk-cdn.d.ts +21 -6
  182. package/dist/viewer/cesdk-cdn.d.ts.map +1 -1
  183. package/dist/viewer/cesdk-cdn.js +26 -7
  184. package/dist/viewer/cesdk-cdn.js.map +1 -1
  185. package/dist/viewer/listener.d.ts +2 -0
  186. package/dist/viewer/listener.d.ts.map +1 -1
  187. package/dist/viewer/listener.js +2 -0
  188. package/dist/viewer/listener.js.map +1 -1
  189. package/dist/viewer/presigned-r2-url-builder.d.ts +1 -1
  190. package/dist/viewer/presigned-r2-url-builder.js +1 -1
  191. package/dist/viewer/presigned-r2-url-builder.js.map +1 -1
  192. package/dist/viewer/router.d.ts.map +1 -1
  193. package/dist/viewer/router.js +11 -18
  194. package/dist/viewer/router.js.map +1 -1
  195. package/dist/viewer/session-mount.js.map +1 -1
  196. package/dist/viewer/spa-assets.generated.d.ts.map +1 -1
  197. package/dist/viewer/spa-assets.generated.js +757 -869
  198. package/dist/viewer/spa-assets.generated.js.map +1 -1
  199. package/dist/viewer/url-builder.d.ts +4 -3
  200. package/dist/viewer/url-builder.d.ts.map +1 -1
  201. package/dist/viewer/url-builder.js +4 -4
  202. package/dist/viewer/url-builder.js.map +1 -1
  203. package/package.json +6 -5
  204. package/dist/cross-ref.d.ts +0 -2
  205. package/dist/cross-ref.d.ts.map +0 -1
  206. package/dist/cross-ref.js +0 -31
  207. package/dist/cross-ref.js.map +0 -1
  208. package/dist/skill-tools.d.ts +0 -3
  209. package/dist/skill-tools.d.ts.map +0 -1
  210. package/dist/skill-tools.js +0 -105
  211. package/dist/skill-tools.js.map +0 -1
  212. package/dist/tools/open-editor.d.ts.map +0 -1
  213. package/dist/tools/open-editor.js.map +0 -1
  214. /package/assets/docs/guide/{create-video → create-audio}/audio/adjust-speed.md +0 -0
  215. /package/assets/docs/guide/{create-video → create-audio}/audio/adjust-volume.md +0 -0
@@ -12680,6 +12680,160 @@ Create cutout operations and path-based modifications.
12680
12680
  ```
12681
12681
  </details>
12682
12682
 
12683
+ ## Block Transitions
12684
+
12685
+ <details>
12686
+ <summary>
12687
+ ### createTransition()
12688
+
12689
+ <br /><p>Creates a new transition block.</p>
12690
+ </summary>
12691
+
12692
+ The created block is standalone until assigned to a clip with `setTransition`.
12693
+ Once assigned, it is owned by that clip: it is destroyed together with the
12694
+ clip, and the engine also destroys it automatically when the two clips stop
12695
+ being timeline-adjacent on the track (e.g. after a manual gap is introduced).
12696
+
12697
+ #### Parameters
12698
+
12699
+ | Parameter | Type | Description |
12700
+ | ------ | ------ | ------ |
12701
+ | `type` | [`TransitionType`](./api/node/type-aliases/transitiontype.md) | The type of transition to create. |
12702
+
12703
+ #### Returns
12704
+
12705
+ `number`
12706
+
12707
+ The handle of the new transition instance.
12708
+
12709
+ #### Signature
12710
+
12711
+ ```typescript
12712
+ createTransition(type: TransitionType): number
12713
+ ```
12714
+
12715
+ ***
12716
+ </details>
12717
+
12718
+ <details>
12719
+ <summary>
12720
+ ### supportsTransition()
12721
+
12722
+ <br /><p>Checks whether a clip can own an outgoing clip-to-clip transition.</p>
12723
+ </summary>
12724
+
12725
+ Only leaf clips inside a video track qualify. Audio, group, caption, and
12726
+ cutout blocks — as well as blocks outside a video track — report `false`.
12727
+
12728
+ #### Parameters
12729
+
12730
+ | Parameter | Type | Description |
12731
+ | ------ | ------ | ------ |
12732
+ | `id` | `number` | The clip block to check. |
12733
+
12734
+ #### Returns
12735
+
12736
+ `boolean`
12737
+
12738
+ Whether the block can own an outgoing transition.
12739
+
12740
+ #### Signature
12741
+
12742
+ ```typescript
12743
+ supportsTransition(id: number): boolean
12744
+ ```
12745
+
12746
+ ***
12747
+ </details>
12748
+
12749
+ <details>
12750
+ <summary>
12751
+ ### setTransition()
12752
+
12753
+ <br /><p>Assigns the outgoing transition of a clip.</p>
12754
+ </summary>
12755
+
12756
+ A previously assigned transition block is detached but not destroyed
12757
+ automatically. Throws an error if the given transition block is invalid or
12758
+ already assigned to another clip. Both the clip and its following clip on
12759
+ the track must support transitions, see `supportsTransition`. To clear a
12760
+ clip's transition, use `removeTransition` instead.
12761
+
12762
+ #### Parameters
12763
+
12764
+ | Parameter | Type | Description |
12765
+ | ------ | ------ | ------ |
12766
+ | `id` | `number` | The outgoing clip that owns the transition relation. |
12767
+ | `transition` | `number` | The transition block to assign. |
12768
+
12769
+ #### Returns
12770
+
12771
+ `void`
12772
+
12773
+ #### Signature
12774
+
12775
+ ```typescript
12776
+ setTransition(id: number, transition: number): void
12777
+ ```
12778
+
12779
+ ***
12780
+ </details>
12781
+
12782
+ <details>
12783
+ <summary>
12784
+ ### removeTransition()
12785
+
12786
+ <br /><p>Removes the outgoing transition of a clip.</p>
12787
+ </summary>
12788
+
12789
+ The removed transition block is detached but not destroyed automatically.
12790
+ Removing from a clip without an assigned transition is a no-op.
12791
+
12792
+ #### Parameters
12793
+
12794
+ | Parameter | Type | Description |
12795
+ | ------ | ------ | ------ |
12796
+ | `id` | `number` | The outgoing clip whose transition relation should be cleared. |
12797
+
12798
+ #### Returns
12799
+
12800
+ `void`
12801
+
12802
+ #### Signature
12803
+
12804
+ ```typescript
12805
+ removeTransition(id: number): void
12806
+ ```
12807
+
12808
+ ***
12809
+ </details>
12810
+
12811
+ <details>
12812
+ <summary>
12813
+ ### getTransition()
12814
+
12815
+ <br /><p>Gets the outgoing transition assigned to a clip.</p>
12816
+ </summary>
12817
+
12818
+ #### Parameters
12819
+
12820
+ | Parameter | Type | Description |
12821
+ | ------ | ------ | ------ |
12822
+ | `id` | `number` | The outgoing clip whose transition relation should be queried. |
12823
+
12824
+ #### Returns
12825
+
12826
+ `number`
12827
+
12828
+ The assigned transition block, or an invalid block if unset.
12829
+
12830
+ #### Signature
12831
+
12832
+ ```typescript
12833
+ getTransition(id: number): number
12834
+ ```
12835
+ </details>
12836
+
12683
12837
  ## Helper
12684
12838
 
12685
12839
  Convenient high-level functions that combine multiple operations into single, easy-to-use methods for common tasks like adding media, applying effects, and positioning blocks.
@@ -120,7 +120,7 @@ to build and manipulate designs programmatically, or in a browser to create inte
120
120
 
121
121
  <details>
122
122
  <summary>
123
- ### addDefaultAssetSources()
123
+ ### ~~addDefaultAssetSources()~~
124
124
 
125
125
  <br /><p>Register a set of asset sources containing default assets.</p>
126
126
  </summary>
@@ -133,7 +133,9 @@ to build and manipulate designs programmatically, or in a browser to create inte
133
133
  - `'ly.img.filter.duotone'` - Color effects of various kinds
134
134
 
135
135
  These assets are parsed at \{\{base\_url}}/\<id>/content.json, where
136
- `base_url` defaults to the IMG.LY CDN.
136
+ `base_url` defaults to the engine's configured baseURL. For `@cesdk/node`
137
+ that is the local package (`file://<pkg>/assets/`), which does not bundle
138
+ these sources, so pass a `baseURL` to load them.
137
139
  Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
138
140
  assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
139
141
 
@@ -142,7 +144,7 @@ to build and manipulate designs programmatically, or in a browser to create inte
142
144
  | Parameter | Type | Description |
143
145
  | ------ | ------ | ------ |
144
146
  | `options?` | \{ `baseURL?`: `string`; `excludeAssetSourceIds?`: [`DefaultAssetSourceId`](./api/node/type-aliases/defaultassetsourceid.md)\[]; } | Configuration options for loading default asset sources. |
145
- | `options.baseURL?` | `string` | The source of the asset definitions, must be absolute. Defaults to IMG.LY CDN. |
147
+ | `options.baseURL?` | `string` | The source of the asset definitions, must be absolute. Defaults to the engine's configured baseURL. |
146
148
  | `options.excludeAssetSourceIds?` | [`DefaultAssetSourceId`](./api/node/type-aliases/defaultassetsourceid.md)\[] | A list of IDs, that will be ignored during load. |
147
149
 
148
150
  #### Returns
@@ -151,18 +153,17 @@ to build and manipulate designs programmatically, or in a browser to create inte
151
153
 
152
154
  A promise that resolves when all asset sources are loaded.
153
155
 
154
- #### Signature
156
+ #### Deprecated
155
157
 
156
- ```typescript
157
- addDefaultAssetSources(options?: object): Promise<void>
158
- ```
158
+ This method uses legacy v4 asset source IDs and will be removed in a future version.
159
+ Please migrate to v5 asset sources using engine.asset.addLocalAssetSourceFromJSONURI().
159
160
 
160
161
  ***
161
162
  </details>
162
163
 
163
164
  <details>
164
165
  <summary>
165
- ### addDemoAssetSources()
166
+ ### ~~addDemoAssetSources()~~
166
167
 
167
168
  <br /><p>Register a set of demo asset sources containing example assets.</p>
168
169
  </summary>
@@ -183,7 +184,7 @@ to build and manipulate designs programmatically, or in a browser to create inte
183
184
  | Parameter | Type | Description |
184
185
  | ------ | ------ | ------ |
185
186
  | `options?` | \{ `baseURL?`: `string`; `excludeAssetSourceIds?`: [`DemoAssetSourceId`](./api/node/type-aliases/demoassetsourceid.md)\[]; `sceneMode?`: `"Design"` | `"Video"`; `withUploadAssetSources?`: `boolean`; } | Configuration options for loading demo asset sources. |
186
- | `options.baseURL?` | `string` | The source of the demo asset definitions, must be absolute. Defaults to IMG.LY CDN. |
187
+ | `options.baseURL?` | `string` | The source of the demo asset definitions, must be absolute. Defaults to the engine's configured baseURL. |
187
188
  | `options.excludeAssetSourceIds?` | [`DemoAssetSourceId`](./api/node/type-aliases/demoassetsourceid.md)\[] | A list of IDs, that will be ignored during load |
188
189
  | `options.sceneMode?` | `"Design"` | `"Video"` | If 'Video' video specific demo asset sources will be loaded as well (default 'Design') |
189
190
  | `options.withUploadAssetSources?` | `boolean` | If 'true' asset sources for uploads are added (default false) |
@@ -194,11 +195,10 @@ to build and manipulate designs programmatically, or in a browser to create inte
194
195
 
195
196
  A promise that resolves when all demo asset sources are loaded.
196
197
 
197
- #### Signature
198
+ #### Deprecated
198
199
 
199
- ```typescript
200
- addDemoAssetSources(options?: object): Promise<void>
201
- ```
200
+ This method uses legacy v3 demo asset source IDs and will be removed in a future version.
201
+ Please migrate to v4 asset sources using engine.asset.addLocalAssetSourceFromJSONURI().
202
202
  </details>
203
203
 
204
204
  ## Other
@@ -0,0 +1,23 @@
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
+ One bucket of a facet distribution.
6
+
7
+ ## Properties
8
+
9
+ | Property | Type | Description |
10
+ | ------ | ------ | ------ |
11
+ | `value` | `string` | Raw value exactly as stored on the assets (no casing or locale normalization). |
12
+ | `count?` | `number` | Number of matched assets carrying this value. Always set by local sources; custom sources may omit it when counting is expensive. |
13
+
14
+
15
+ ---
16
+
17
+ ## More Resources
18
+
19
+ - **[Node.js Documentation Index](https://img.ly/docs/cesdk/node.md)** - Browse all Node.js documentation
20
+ - **[node API Reference](./api/node.md)** - Full node API reference
21
+ - **[Complete Documentation](./llms-full.txt.md)** - Full documentation in one file (for LLMs)
22
+ - **[Web Documentation](./node.md)** - Interactive documentation with examples
23
+ - **[Support](mailto:support@img.ly)** - Contact IMG.LY support
@@ -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