@imgly/codesign-mcp 0.1.5 → 0.1.7

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

@@ -14,7 +14,6 @@ registerApplyMiddleware(middleware: (sourceId: string, assetResult: AssetResult,
 ```
 
 **Parameters:**
-
 - `middleware` - The middleware function that is called before applying the asset.
 
 **Returns:** A function that can be used to remove the middleware.
@@ -30,7 +29,6 @@ registerApplyToBlockMiddleware(middleware: (sourceId: string, assetResult: Asset
 ```
 
 **Parameters:**
-
 - `middleware` - The middleware function that is called before applying the asset.
 
 **Returns:** A function that can be used to remove the middleware.
@@ -47,7 +45,6 @@ apply(sourceId: string, assetResult: AssetResult, options?: ApplyAssetOptions):
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 - `assetResult` - A single asset result from a `findAssets` query.
 - `options` - Optional configuration for asset application.
@@ -59,7 +56,6 @@ apply(sourceId: string, assetResult: AssetResult, options?: ApplyAssetOptions):
 Apply an asset to a specific block.
 Modifies the target block's properties according to the asset's configuration.
 The behavior can be customized by providing an `applyAssetToBlock` function when registering the asset source.
-
 ```javascript
 await engine.asset.applyToBlock('asset-source-id', assetResult.assets[0]);
 ```
@@ -69,7 +65,6 @@ applyToBlock(sourceId: string, assetResult: AssetResult, block: DesignBlockId):
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 - `assetResult` - A single asset result from a `findAssets` query.
 - `block` - The block to apply the asset to.
@@ -79,7 +74,6 @@ applyToBlock(sourceId: string, assetResult: AssetResult, block: DesignBlockId):
 Apply a specific asset property to the currently selected element.
 Allows applying individual properties (like colors, fonts, or effects) from an asset
 without creating a new block. The behavior can be customized by providing an `applyAssetProperty` function.
-
 ```javascript
 const asset = assetResult.assets[0];
 if (asset.payload && asset.payload.properties) {
@@ -94,7 +88,6 @@ applyProperty(sourceId: string, assetResult: AssetResult, property: AssetPropert
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 - `assetResult` - A single asset result from a `findAssets` query.
 - `property` - The specific asset property to apply.
@@ -103,7 +96,6 @@ applyProperty(sourceId: string, assetResult: AssetResult, property: AssetPropert
 
 Apply an asset using the engine's default implementation.
 The default implementation already handles various different kinds of assets and acts as a good starting point.
-
 ```javascript
 engine.asset.addSource({
   id: 'foobar',
@@ -113,7 +105,7 @@ engine.asset.addSource({
         {
           id: 'logo',
           meta: {
-            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg'
+            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg',
           }
         }
       ],
@@ -124,7 +116,7 @@ engine.asset.addSource({
   },
   async applyAsset(assetResult) {
     return engine.asset.defaultApplyAsset(assetResult);
-  }
+  },
 });
 ```
 
@@ -133,7 +125,6 @@ defaultApplyAsset(assetResult: AssetResult): Promise<DesignBlockId | undefined>
 ```
 
 **Parameters:**
-
 - `assetResult` - A single asset result from a `findAssets` query.
 
 **Returns:** Promise resolving to the created block ID, or undefined if no block was created.
@@ -142,7 +133,6 @@ defaultApplyAsset(assetResult: AssetResult): Promise<DesignBlockId | undefined>
 
 Apply an asset to a block using the engine's default implementation.
 The default implementation already handles various different kinds of assets and acts as a good starting point.
-
 ```javascript
 engine.asset.addSource({
   id: 'foobar',
@@ -152,7 +142,7 @@ engine.asset.addSource({
         {
           id: 'logo',
           meta: {
-            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg'
+            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg',
           }
         }
       ],
@@ -163,7 +153,7 @@ engine.asset.addSource({
   },
   async applyAssetToBlock(assetResult, block) {
     engine.asset.defaultApplyAssetToBlock(assetResult, block);
-  }
+  },
 });
 ```
 
@@ -172,7 +162,6 @@ defaultApplyAssetToBlock(assetResult: AssetResult, block: DesignBlockId): Promis
 ```
 
 **Parameters:**
-
 - `assetResult` - A single asset result from a `findAssets` query.
 - `block` - The block to apply the asset to.
 
@@ -183,7 +172,6 @@ defaultApplyAssetToBlock(assetResult: AssetResult, block: DesignBlockId): Promis
 Add a custom asset source with unique ID.
 The asset source provides methods for finding assets, applying them to scenes or blocks,
 and managing asset lifecycle. All source operations are handled asynchronously.
-
 ```javascript
 engine.asset.addSource({
   id: 'foobar',
@@ -193,7 +181,7 @@ engine.asset.addSource({
         {
           id: 'logo',
           meta: {
-            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg'
+            uri: 'https://img.ly/static/ubq_samples/imgly_logo.jpg',
           }
         }
       ],
@@ -201,7 +189,7 @@ engine.asset.addSource({
       currentPage: queryData.page,
       nextPage: undefined
     });
-  }
+  },
 });
 ```
 
@@ -210,7 +198,6 @@ addSource(source: AssetSource): void
 ```
 
 **Parameters:**
-
 - `source` - The asset source configuration.
 
 ### addLocalSource()
@@ -218,7 +205,6 @@ addSource(source: AssetSource): void
 Add a local asset source.
 Local asset sources allow dynamic asset management through the add/remove methods.
 You can specify supported MIME types to restrict what assets can be added.
-
 ```javascript
 engine.asset.addLocalSource('local-source');
 ```
@@ -228,7 +214,6 @@ addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: C
 ```
 
 **Parameters:**
-
 - `id` - Unique identifier for the asset source.
 - `supportedMimeTypes` - The mime types of assets that are allowed to be added to this local source.
 - `applyAsset` - An optional callback that can be used to override the default behavior of applying a given asset result to the active scene.
@@ -251,7 +236,6 @@ addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string, option
 ```
 
 **Parameters:**
-
 - `contentJSON` - The JSON string containing the asset definitions.
 - `basePath` - An optional base path with which \{\{base_url\}\} strings in the assets should be replaced. If no value is provided, settings.basePath is used.
 - `options` - Optional configuration:
@@ -276,7 +260,6 @@ addLocalAssetSourceFromJSONURI(contentURI: string, options?: {
 ```
 
 **Parameters:**
-
 - `contentURI` - The URI for the JSON file to load and parse.
 - `options` - Optional configuration:
   - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
@@ -288,7 +271,6 @@ addLocalAssetSourceFromJSONURI(contentURI: string, options?: {
 Remove a registered asset source.
 This permanently removes the asset source and all its associated assets.
 Any ongoing operations with this source will be cancelled.
-
 ```javascript
 engine.asset.removeSource('asset-source-id');
 ```
@@ -298,13 +280,11 @@ removeSource(id: string): void
 ```
 
 **Parameters:**
-
 - `id` - The ID of the asset source to remove.
 
 ### findAllSources()
 
 Get all registered asset source IDs.
-
 ```javascript
 engine.asset.findAllSources();
 ```
@@ -322,7 +302,6 @@ findAllSources(): string[]
 Search for assets in a specific source with advanced filtering.
 Supports pagination, text search, tag filtering, grouping, and sorting options.
 Results include asset metadata, thumbnails, and application context.
-
 ```javascript
 const result = await engine.asset.findAssets('asset-source-id', {
   page: 0,
@@ -336,7 +315,6 @@ findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult<C
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 - `query` - Query options to filter and sort the search results.
 
@@ -345,7 +323,6 @@ findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult<C
 ### fetchAsset()
 
 Fetch a specific asset by ID from an asset source.
-
 ```javascript
 const asset = await engine.asset.fetchAsset('asset-source-id', 'asset-id', {
   locale: 'en-US'
@@ -357,7 +334,6 @@ fetchAsset(sourceId: string, assetId: string, params?: Pick<AssetQueryData, 'loc
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source to search in.
 - `assetId` - The ID of the asset to fetch.
 - `params` - Query parameters including locale (optional).
@@ -370,7 +346,6 @@ fetchAsset(sourceId: string, assetId: string, params?: Pick<AssetQueryData, 'loc
 
 Get available asset groups from a source.
 Groups provide categorization for assets within a source, enabling filtered discovery.
-
 ```javascript
 const groups = engine.asset.getGroups(customSource.id);
 ```
@@ -380,7 +355,6 @@ getGroups(id: string): Promise<string[]>
 ```
 
 **Parameters:**
-
 - `id` - The ID of the asset source.
 
 **Returns:** Promise resolving to list of available group names.
@@ -389,7 +363,6 @@ getGroups(id: string): Promise<string[]>
 
 Get supported MIME types for an asset source.
 Returns the file types that can be added to this source. An empty result means all MIME types are supported.
-
 ```javascript
 const mimeTypes = engine.asset.getSupportedMimeTypes('asset-source-id');
 ```
@@ -399,7 +372,6 @@ getSupportedMimeTypes(sourceId: string): string[]
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 
 **Returns:** Array of supported MIME type strings.
@@ -407,7 +379,6 @@ getSupportedMimeTypes(sourceId: string): string[]
 ### getCredits()
 
 Get attribution credits for an asset source.
-
 ```javascript
 const credits = engine.asset.getCredits('asset-source-id');
 ```
@@ -420,7 +391,6 @@ getCredits(sourceId: string): {
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 
 **Returns:** The asset source's credits info consisting of a name and an optional URL.
@@ -428,7 +398,6 @@ getCredits(sourceId: string): {
 ### getLicense()
 
 Get license information for an asset source.
-
 ```javascript
 const license = engine.asset.getLicense('asset-source-id');
 ```
@@ -441,7 +410,6 @@ getLicense(sourceId: string): {
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source.
 
 **Returns:** The asset source's license info consisting of a name and an optional URL.
@@ -451,7 +419,6 @@ getLicense(sourceId: string): {
 Check if an asset source supports asset management.
 Returns true if the source allows adding and removing assets dynamically, via 'Add File' and 'Delete' button on the UI.
 This is typically true for local asset sources and false for remote sources.
-
 ```javascript
 engine.asset.canManageAssets('asset-source-id');
 ```
@@ -461,7 +428,6 @@ canManageAssets(sourceId: string): boolean
 ```
 
 **Parameters:**
-
 - `sourceId` - The ID of the asset source to check.
 
 **Returns:** True if the source supports asset management operations.
@@ -473,7 +439,6 @@ canManageAssets(sourceId: string): boolean
 Add an asset to a local asset source.
 Only works with local asset sources that support asset management.
 The asset will be validated against the source's supported MIME types.
-
 ```javascript
 engine.asset.addAssetToSource('local-source', {
   id: 'asset-id',
@@ -492,7 +457,6 @@ addAssetToSource(sourceId: string, asset: AssetDefinition): void
 ```
 
 **Parameters:**
-
 - `sourceId` - The local asset source ID that the asset should be added to.
 - `asset` - The asset definition to add to the source.
 
@@ -501,7 +465,6 @@ addAssetToSource(sourceId: string, asset: AssetDefinition): void
 Remove an asset from a local asset source.
 Only works with local asset sources that support asset management.
 The asset will be permanently deleted from the source.
-
 ```javascript
 engine.asset.removeAssetFromSource('local-source', 'asset-id');
 ```
@@ -511,7 +474,6 @@ removeAssetFromSource(sourceId: string, assetId: string): void
 ```
 
 **Parameters:**
-
 - `sourceId` - The id of the local asset source that currently contains the asset.
 - `assetId` - The id of the asset to be removed.
 
@@ -520,7 +482,6 @@ removeAssetFromSource(sourceId: string, assetId: string): void
 Notify the engine that an asset source's contents have changed.
 This triggers refresh of any UI components that display assets from this source
 and notifies subscribers to the asset source update events.
-
 ```javascript
 engine.asset.assetSourceContentsChanged('asset-source-id');
 ```
@@ -530,7 +491,6 @@ assetSourceContentsChanged(sourceID: string): void
 ```
 
 **Parameters:**
-
 - `sourceID` - The asset source whose contents changed.
 
 ## Event Subscriptions
@@ -540,7 +500,6 @@ Subscribe to asset source changes and lifecycle events.
 ### onAssetSourceAdded()
 
 Subscribe to asset source addition events.
-
 ```javascript
 engine.asset.onAssetSourceAdded((sourceID) => {
   console.log(`Added source: ${sourceID}`);
@@ -552,7 +511,6 @@ onAssetSourceAdded(callback: (sourceID: string) => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - The function called whenever an asset source is added.
 
 **Returns:** A method to unsubscribe from the event.
@@ -560,7 +518,6 @@ onAssetSourceAdded(callback: (sourceID: string) => void): (() => void)
 ### onAssetSourceRemoved()
 
 Subscribe to asset source removal events.
-
 ```javascript
 engine.asset.onAssetSourceRemoved((sourceID) => {
   console.log(`Removed source: ${sourceID}`);
@@ -572,7 +529,6 @@ onAssetSourceRemoved(callback: (sourceID: string) => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - The function called whenever an asset source is removed.
 
 **Returns:** A method to unsubscribe from the event.
@@ -580,7 +536,6 @@ onAssetSourceRemoved(callback: (sourceID: string) => void): (() => void)
 ### onAssetSourceUpdated()
 
 Subscribe to asset source content change events.
-
 ```javascript
 engine.asset.onAssetSourceUpdated((sourceID) => {
   console.log(`Updated source: ${sourceID}`);
@@ -592,11 +547,10 @@ onAssetSourceUpdated(callback: (sourceID: string) => void): (() => void)
 ```
 
 **Parameters:**
-
 - `callback` - The function called whenever an asset source's contents are updated.
 
 **Returns:** A method to unsubscribe from the event.
 
 ---
 
-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/).