@imgly/codesign-mcp 0.1.5 → 0.1.6

package/assets/docs/guide/api/EditorAPI.md

@@ -11,17 +11,35 @@ onStateChanged(callback: () => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - Function called when the editor state changes.
 
 **Returns:** A method to unsubscribe from the event.
 
-### onHistoryUpdated()
+### onHistoryUpdated() *(deprecated)*
 
 Subscribe to undo/redo history changes.
 
+```typescript
+onHistoryUpdated(callback: () => void): (() => void)
+```
+
+**Parameters:**
+- `callback` - Function called when the undo/redo history changes.
+
+**Returns:** A method to unsubscribe from the event.
+
+### onHistoryUpdatedWithKind()
+
+Subscribe to undo/redo history changes.
+The callback receives a {@link HistoryUpdate} describing what kind of update happened so consumers can
+distinguish a real change to the active history's snapshots (e.g. an edit, undo, or redo) from a pure activation
+via `setActiveHistory`.
 ```javascript
-const unsubscribe = engine.editor.onHistoryUpdated(() => {
+const unsubscribe = engine.editor.onHistoryUpdatedWithKind((kind) => {
+  if (kind === 'Activated') {
+    // The active history was switched; no scene change happened on this event.
+    return;
+  }
   const canUndo = engine.editor.canUndo();
   const canRedo = engine.editor.canRedo();
   console.log('History updated', { canUndo, canRedo });
@@ -29,12 +47,11 @@ const unsubscribe = engine.editor.onHistoryUpdated(() => {
 ```
 
 ```typescript
-onHistoryUpdated(callback: () => void): (() => void)
+onHistoryUpdatedWithKind(callback: (kind: HistoryUpdate) => void): (() => void)
 ```
 
 **Parameters:**
-
-- `callback` - Function called when the undo/redo history changes.
+- `callback` - Function called when the undo/redo history changes. The argument describes the kind of update.
 
 **Returns:** A method to unsubscribe from the event.
 
@@ -47,7 +64,6 @@ onSettingsChanged(callback: () => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - Function called when editor settings change.
 
 **Returns:** A method to unsubscribe from the event.
@@ -63,7 +79,6 @@ onRoleChanged(callback: (role: RoleString) => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - Function called when the user role changes.
 
 **Returns:** A method to unsubscribe from the event.
@@ -74,7 +89,6 @@ onRoleChanged(callback: (role: RoleString) => void): (() => void)
 
 Set the editor's current edit mode.
 Edit modes represent different tools or interaction states within the editor. Common ones, are "Crop" while the crop tool is shown or "Text" when inline-editing text.
-
 ```javascript
 engine.editor.setEditMode('Crop');
 // With a base mode
@@ -86,7 +100,6 @@ setEditMode(mode: EditMode, baseMode?: string): void
 ```
 
 **Parameters:**
-
 - `mode` - "Transform", "Crop", "Text", "Playback", "Trim", "Vector" or a custom value.
 - `baseMode` - Optional base mode from which the custom mode will inherit the settings.
 
@@ -220,7 +233,6 @@ setVectorEditBendMode(active: boolean): void
 ```
 
 **Parameters:**
-
 - `active` - true to enable bend mode, false to return to normal move mode.
 
 ### getVectorEditBendMode()
@@ -244,7 +256,6 @@ setVectorEditAddMode(active: boolean): void
 ```
 
 **Parameters:**
-
 - `active` - true to enable add mode, false to return to normal move mode.
 
 ### getVectorEditAddMode()
@@ -268,7 +279,6 @@ setVectorEditDeleteMode(active: boolean): void
 ```
 
 **Parameters:**
-
 - `active` - true to enable delete mode, false to return to normal move mode.
 
 ### getVectorEditDeleteMode()
@@ -285,7 +295,6 @@ getVectorEditDeleteMode(): boolean
 
 Set the bezier handle mirror mode for the currently selected vector node.
 Mirror modes control how the opposite handle behaves when one handle is dragged:
-
 - 0 (None): handles move independently
 - 1 (AngleAndLength): the opposite handle mirrors both angle and length
 - 2 (AngleOnly): the opposite handle mirrors the angle but keeps its own length
@@ -295,7 +304,6 @@ setSelectedVectorNodeMirrorMode(mode: number): void
 ```
 
 **Parameters:**
-
 - `mode` - The mirror mode (0, 1, or 2).
 
 ### getSelectedVectorNodeMirrorMode()
@@ -314,7 +322,6 @@ getSelectedVectorNodeMirrorMode(): number
 
 Create a new undo/redo history stack.
 Multiple histories can exist, but only one can be active at a time.
-
 ```javascript
 const newHistory = engine.editor.createHistory();
 ```
@@ -328,7 +335,6 @@ createHistory(): HistoryId
 ### destroyHistory()
 
 Destroy a history stack and free its resources.
-
 ```javascript
 engine.editor.destroyHistory(oldHistory);
 ```
@@ -338,14 +344,12 @@ destroyHistory(history: HistoryId): void
 ```
 
 **Parameters:**
-
 - `history` - The history handle to destroy.
 
 ### setActiveHistory()
 
 Set a history as the active undo/redo stack.
 All other histories lose their active state. Undo/redo operations only apply to the active history.
-
 ```javascript
 engine.editor.setActiveHistory(newHistory);
 ```
@@ -355,14 +359,12 @@ setActiveHistory(history: HistoryId): void
 ```
 
 **Parameters:**
-
 - `history` - The history handle to make active.
 
 ### getActiveHistory()
 
 Get the currently active history handle.
 Creates a new history if none exists.
-
 ```javascript
 const oldHistory = engine.editor.getActiveHistory();
 ```
@@ -377,9 +379,8 @@ getActiveHistory(): HistoryId
 
 Add a new history state to the undo stack.
 Only adds a state if undoable changes were made since the last undo step.
-
 ```javascript
-engine.editor.addUndoStep();
+  engine.editor.addUndoStep();
 ```
 
 ```typescript
@@ -390,9 +391,8 @@ addUndoStep(): void
 
 Remove the last history state from the undo stack.
 Removes the most recent undo step if available.
-
 ```javascript
-engine.editor.removeUndoStep();
+  engine.editor.removeUndoStep();
 ```
 
 ```typescript
@@ -402,7 +402,6 @@ removeUndoStep(): void
 ### undo()
 
 Undo one step in the active history if an undo step is available.
-
 ```javascript
 engine.editor.undo();
 ```
@@ -414,7 +413,6 @@ undo(): void
 ### redo()
 
 Redo one step in the active history if a redo step is available.
-
 ```javascript
 engine.editor.redo();
 ```
@@ -426,7 +424,6 @@ redo(): void
 ### canUndo()
 
 Check if an undo step is available.
-
 ```javascript
 if (engine.editor.canUndo()) {
   engine.editor.undo();
@@ -442,7 +439,6 @@ canUndo(): boolean
 ### canRedo()
 
 Check if a redo step is available.
-
 ```javascript
 if (engine.editor.canRedo()) {
   engine.editor.redo();
@@ -467,7 +463,6 @@ setSetting<K extends SettingKey>(keypath: OptionalPrefix<K>, value: SettingValue
 ```
 
 **Parameters:**
-
 - `keypath` - The setting key from Settings
 - `value` - The value to set (type-safe based on key)
 
@@ -481,7 +476,6 @@ getSetting<K extends SettingKey>(keypath: OptionalPrefix<K>): SettingValueType<K
 ```
 
 **Parameters:**
-
 - `keypath` - The setting key from Settings
 
 **Returns:** The value of the setting (type-safe based on key)
@@ -495,7 +489,6 @@ setSettingBool(keypath: SettingsBool, value: boolean): void
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickToCropEnabled`.
 - `value` - The boolean value to set.
 
@@ -508,7 +501,6 @@ getSettingBool(keypath: SettingsBool): boolean
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickToCropEnabled`.
 
 **Returns:** The boolean value of the setting.
@@ -522,7 +514,6 @@ setSettingInt(keypath: SettingsInt, value: number): void
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath.
 - `value` - The integer value to set.
 
@@ -535,7 +526,6 @@ getSettingInt(keypath: SettingsInt): number
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath.
 
 **Returns:** The integer value of the setting.
@@ -549,7 +539,6 @@ setSettingFloat(keypath: SettingsFloat, value: number): void
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `positionSnappingThreshold`.
 - `value` - The float value to set.
 
@@ -562,7 +551,6 @@ getSettingFloat(keypath: SettingsFloat): number
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `positionSnappingThreshold`.
 
 **Returns:** The float value of the setting.
@@ -576,7 +564,6 @@ setSettingString(keypath: SettingsString, value: string): void
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `license`.
 - `value` - The string value to set.
 
@@ -589,7 +576,6 @@ getSettingString(keypath: SettingsString): string
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `license`.
 
 **Returns:** The string value of the setting.
@@ -603,7 +589,6 @@ setSettingColor(keypath: SettingsColor, value: Color): void
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `highlightColor`.
 - `value` - The The value to set.
 
@@ -616,7 +601,6 @@ getSettingColor(keypath: SettingsColor): Color
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `highlightColor`.
 
 ### setSettingEnum<T extends keyof SettingEnumType>()
@@ -628,7 +612,6 @@ setSettingEnum<T extends keyof SettingEnumType>(keypath: T, value: SettingEnumTy
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickSelectionMode`.
 - `value` - The enum value as string.
 
@@ -641,7 +624,6 @@ getSettingEnum<T extends keyof SettingEnumType>(keypath: T): SettingEnumType[T]
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickSelectionMode`.
 
 **Returns:** The value as string.
@@ -655,7 +637,6 @@ getSettingEnumOptions<T extends keyof SettingEnumType>(keypath: T): SettingEnumT
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickSelectionMode`.
 
 **Returns:** The possible enum options as strings.
@@ -679,7 +660,6 @@ getSettingType(keypath: string): SettingType
 ```
 
 **Parameters:**
-
 - `keypath` - The settings keypath, e.g. `doubleClickSelectionMode`.
 
 **Returns:** The setting type.
@@ -690,7 +670,6 @@ Sets a custom URI resolver.
 This function can be called more than once. Subsequent calls will overwrite previous calls.
 To remove a previously set resolver, pass the value `null`.
 The given function must return an absolute path with a scheme and cannot be asynchronous. The input is allowed to be an invalid URI, e.g., due to placeholders.
-
 ```javascript
 // Replace all .jpg files with the IMG.LY logo
 engine.editor.setURIResolver((uri) => {
@@ -707,10 +686,9 @@ setURIResolver(resolver: SyncURIResolver): void
 ```
 
 **Parameters:**
-
 - `resolver` - Custom resolution function. The resolution function
-  should not reference variables outside of its scope.
-  It receives the default URI resolver as its second argument
+                  should not reference variables outside of its scope.
+                  It receives the default URI resolver as its second argument
 
 ### setURIResolverAsync()
 
@@ -725,14 +703,12 @@ setURIResolverAsync(resolver: AsyncURIResolver | null): void
 ```
 
 **Parameters:**
-
 - `resolver` - Custom async resolution function.
 
 ### defaultURIResolver()
 
 This is the default implementation for the URI resolver.
 It resolves the given path relative to the `basePath` setting.
-
 ```javascript
 engine.editor.defaultURIResolver(uri);
 ```
@@ -742,7 +718,6 @@ defaultURIResolver(relativePath: string): string
 ```
 
 **Parameters:**
-
 - `relativePath` - The relative path that should be resolved.
 
 **Returns:** The resolved absolute URI.
@@ -761,7 +736,6 @@ getAbsoluteURI(relativePath: string): Promise<string>
 ```
 
 **Parameters:**
-
 - `relativePath` - A relative path string
 
 **Returns:** Promise resolving to the resolved absolute uri or rejecting if an invalid path was given.
@@ -778,7 +752,6 @@ setRole(role: RoleString): void
 ```
 
 **Parameters:**
-
 - `role` - The role to assign to the user.
 
 ### getRole()
@@ -810,7 +783,6 @@ setGlobalScope(key: Scope, value: 'Allow' | 'Deny' | 'Defer'): void
 ```
 
 **Parameters:**
-
 - `key` - The scope to configure.
 - `value` - `Allow` always allows, `Deny` always denies, `Defer` defers to block-level.
 
@@ -823,7 +795,6 @@ getGlobalScope(key: Scope): 'Allow' | 'Deny' | 'Defer'
 ```
 
 **Parameters:**
-
 - `key` - The scope to query.
 
 **Returns:** `Allow`, `Deny`, or `Defer` indicating the scope's permission level.
@@ -887,7 +858,6 @@ getSpotColorRGBA(name: string): RGBA
 ```
 
 **Parameters:**
-
 - `name` - The name of a spot color.
 
 **Returns:** A result holding a float array of the four color components.
@@ -902,7 +872,6 @@ getSpotColorCMYK(name: string): CMYK
 ```
 
 **Parameters:**
-
 - `name` - The name of a spot color.
 
 **Returns:** A result holding a float array of the four color components.
@@ -917,7 +886,6 @@ setSpotColorRGB(name: string, r: number, g: number, b: number): void
 ```
 
 **Parameters:**
-
 - `name` - The name of a spot color.
 - `r` - The red color component in the range of 0 to 1.
 - `g` - The green color component in the range of 0 to 1.
@@ -933,7 +901,6 @@ setSpotColorCMYK(name: string, c: number, m: number, y: number, k: number): void
 ```
 
 **Parameters:**
-
 - `name` - The name of a spot color.
 - `c` - The cyan color component in the range of 0 to 1.
 - `m` - The magenta color component in the range of 0 to 1.
@@ -949,7 +916,6 @@ removeSpotColor(name: string): void
 ```
 
 **Parameters:**
-
 - `name` - The name of a spot color.
 
 **Returns:** An empty result on success, an error otherwise.
@@ -964,7 +930,6 @@ setSpotColorForCutoutType(type: CutoutType, color: string): void
 ```
 
 **Parameters:**
-
 - `type` - The cutout type.
 - `color` - The spot color name to assign.
 
@@ -977,7 +942,6 @@ getSpotColorForCutoutType(type: CutoutType): string
 ```
 
 **Parameters:**
-
 - `type` - The cutout type.
 
 **Returns:** The color spot name.
@@ -991,7 +955,6 @@ convertColorToColorSpace(color: Color, colorSpace: 'sRGB'): RGBAColor
 ```
 
 **Parameters:**
-
 - `color` - The color to convert.
 - `colorSpace` - The color space to convert to.
 
@@ -1002,7 +965,6 @@ convertColorToColorSpace(color: Color, colorSpace: 'sRGB'): RGBAColor
 ### createBuffer()
 
 Create a resizable buffer for arbitrary data.
-
 ```javascript
 const buffer = engine.editor.createBuffer();
 // Reference the buffer resource from the audio block
@@ -1018,7 +980,6 @@ createBuffer(): string
 ### destroyBuffer()
 
 Destroy a buffer and free its resources.
-
 ```javascript
 engine.editor.destroyBuffer(buffer);
 ```
@@ -1028,13 +989,11 @@ destroyBuffer(uri: string): void
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the buffer to destroy.
 
 ### setBufferData()
 
 Set the data of a buffer at a given offset.
-
 ```javascript
 // Generate 10 seconds of stereo 48 kHz audio data
 const samples = new Float32Array(10 * 2 * 48000);
@@ -1050,7 +1009,6 @@ setBufferData(uri: string, offset: number, data: Uint8Array): void
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the buffer to update.
 - `offset` - The offset in bytes at which to start writing.
 - `data` - The data to write.
@@ -1058,14 +1016,13 @@ setBufferData(uri: string, offset: number, data: Uint8Array): void
 ### getBufferData()
 
 Get the data of a buffer at a given offset.
-
 ```javascript
 engine.editor.findAllTransientResources().forEach((resource) => {
   const bufferURI = resource.URL;
   const length = engine.editor.getBufferLength(buffer);
   const data = engine.editor.getBufferData(buffer, 0, length);
   const blob = new Blob([data]);
-});
+})
 ```
 
 ```typescript
@@ -1073,7 +1030,6 @@ getBufferData(uri: string, offset: number, length: number): Uint8Array
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the buffer to query.
 - `offset` - The offset in bytes at which to start reading.
 - `length` - The number of bytes to read.
@@ -1083,7 +1039,6 @@ getBufferData(uri: string, offset: number, length: number): Uint8Array
 ### setBufferLength()
 
 Set the length of a buffer.
-
 ```javascript
 // Reduce the buffer to half its length
 const currentLength = engine.editor.getBufferLength(buffer);
@@ -1095,14 +1050,12 @@ setBufferLength(uri: string, length: number): void
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the buffer to update.
 - `length` - The new length of the buffer in bytes.
 
 ### getBufferLength()
 
 Get the length of a buffer.
-
 ```javascript
 const length = engine.editor.getBufferLength(buffer);
 ```
@@ -1112,7 +1065,6 @@ getBufferLength(uri: string): number
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the buffer to query.
 
 **Returns:** The length of the buffer in bytes.
@@ -1127,7 +1079,6 @@ getMimeType(uri: string): Promise<string>
 ```
 
 **Parameters:**
-
 - `uri` - The URI of the resource.
 
 **Returns:** Promise resolving to the resource's MIME type.
@@ -1137,20 +1088,12 @@ getMimeType(uri: string): Promise<string>
 Gets the font metrics for a given font file URI.
 If the font is not yet loaded, it will be fetched asynchronously.
 The returned metrics are in the font's design units coordinate space.
-
 ```javascript
-const metrics = await engine.editor.getFontMetrics(
-  '/extensions/ly.img.cesdk.fonts/fonts/Roboto/Roboto-Regular.ttf'
-);
+const metrics = await engine.editor.getFontMetrics('/extensions/ly.img.cesdk.fonts/fonts/Roboto/Roboto-Regular.ttf');
 console.log(metrics.ascender, metrics.descender, metrics.unitsPerEm);
 console.log(metrics.lineGap);
 console.log(metrics.capHeight, metrics.xHeight);
-console.log(
-  metrics.underlineOffset,
-  metrics.underlineSize,
-  metrics.strikeoutOffset,
-  metrics.strikeoutSize
-);
+console.log(metrics.underlineOffset, metrics.underlineSize, metrics.strikeoutOffset, metrics.strikeoutSize);
 ```
 
 ```typescript
@@ -1158,7 +1101,6 @@ getFontMetrics(fontFileUri: string): Promise<FontMetrics>
 ```
 
 **Parameters:**
-
 - `fontFileUri` - The URI of the font file to get metrics from.
 
 **Returns:** A promise resolving to the font metrics.
@@ -1198,11 +1140,10 @@ getResourceData(uri: string, chunkSize: number, onData: (result: Uint8Array) =>
 ```
 
 **Parameters:**
-
 - `uri` - The URL of the resource.
 - `chunkSize` - The size of the chunks in which the resource data is provided.
 - `onData` - The callback function that is called with the resource data or an error if an error occurred.
-  The callback will be called as long as there is data left to provide and the callback returns `true`.
+The callback will be called as long as there is data left to provide and the callback returns `true`.
 
 ### relocateResource()
 
@@ -1214,7 +1155,6 @@ relocateResource(currentUrl: string, relocatedUrl: string): void
 ```
 
 **Parameters:**
-
 - `currentUrl` - The current URL of the resource.
 - `relocatedUrl` - The new URL of the resource.
 
@@ -1238,7 +1178,6 @@ setSafeAreaInsets(insets: {
 ```
 
 **Parameters:**
-
 - `insets` - The inset values in CSS pixels (device-independent)
 
 ### getSafeAreaInsets()
@@ -1258,4 +1197,4 @@ getSafeAreaInsets(): {
 
 ---
 
-For complete type definitions, see the [CE.SDK TypeScript API Reference](https://img.ly/docs/cesdk/engine/api/).
+For complete type definitions, see the [CE.SDK TypeScript API Reference](https://img.ly/docs/cesdk/engine/api/).

package/assets/docs/guide/api/EventAPI.md

@@ -14,7 +14,6 @@ subscribe(blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void): ((
 ```
 
 **Parameters:**
-
 - `blocks` - List of blocks to filter events by. If empty, events for all blocks are sent.
 - `callback` - Function called with bundled events.
 
@@ -22,4 +21,4 @@ subscribe(blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void): ((
 
 ---
 
-For complete type definitions, see the [CE.SDK TypeScript API Reference](https://img.ly/docs/cesdk/engine/api/).
+For complete type definitions, see the [CE.SDK TypeScript API Reference](https://img.ly/docs/cesdk/engine/api/).